Update

PATCH {{baseUrl}}/campaigns/:cmp_id

Update the details of an existing campaign. You need only supply the unique identifier that was returned upon campaign creation.

Request Body

[{"name"=>"name", "value"=>"Fall Sale", "datatype"=>"string"}, {"name"=>"schedule_type", "value"=>"immediate", "datatype"=>"string"}, {"name"=>"description", "value"=>"some description", "datatype"=>"string"}, {"name"=>"send_date", "value"=>"2022-09-01", "datatype"=>"string"}, {"name"=>"target_delivery_date", "value"=>"2022-10-30", "datatype"=>"string"}, {"name"=>"cancel_window_campaign_minutes", "value"=>"3000", "datatype"=>"number"}, {"name"=>"metadata", "value"=>"{\"geo\": \"north\"}", "datatype"=>"string"}, {"name"=>"is_draft", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"use_type", "value"=>"operational", "datatype"=>"string"}, {"name"=>"auto_cancel_if_ncoa", "value"=>"false", "datatype"=>"boolean"}]

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"id":"cmp_e05ee61ff80764b","account_id":"fa9ea650fc7b31a89f92","billing_group_id":"bg_fe3079dcdd80e5ae","name":"My Campaign","description":"My Campaign's description","schedule_type":"immediate","cancel_window_campaign_minutes":60,"metadata":{},"use_type":"marketing","is_draft":true,"deleted":false,"creatives":[],"auto_cancel_if_ncoa":false,"date_created":"2017-09-05T17:47:53.767Z","date_modified":"2017-09-05T17:47:53.767Z","object":"campaign"}