Patch
/campaigns/{campaignid}
Update a campaign with information about the final results of a campaign. Not all campaign fields are updateable by this endpoint.
Security
HTTP
Type bearer
User or account level token in Header, key = 'Authorization', value = 'Bearer '
Path parameters
campaignid
stringRequired
Campaign ID
Body parameters
Final result infromation, only the following properties may be updated
- baseline_open_rate
- test_send_date
- final_send_date
- audience_size
- number_of_splits
- split_size
- number_of_recipients
- final_number_of_unsubs
- final_unsub_rate
- final_unique_opens
- final_unique_open_rate
- final_unique_clicks
- final_unique_click_rate
- final_revenue
- final_number_of_conversions * winning_variant_id
object
campaign_id
string Required
Example59807ed854b8891947e04303
baseline_open_rate
number
Example1.23
test_send_date
string (date)
Example2016-03-15
final_send_date
string (date)
Example2016-03-15
audience_size
integer
Example12300332
number_of_splits
integer
Example10
split_size
integer
Example123000
number_of_recipients
integer
number of messages sent
Example10000000
final_number_of_unsubs
integer
Example452
final_unsub_rate
number
Example55.5
final_unique_opens
integer
Example56
final_unique_open_rate
number
Example8.41
final_unique_clicks
integer
Example55
final_unique_click_rate
number
Example8.26
final_revenue
number
Example5568.21
final_number_of_conversions
integer
Example302
winning_variant_id
string
Example5c07e39e477ca9289615b441
Responses
200
Campaign successfully updated
401
Invalid token
403
Supplied token invalid for requested campaign
422
Campaign data malformed
500
A server side error occurred