Update Campaign Message
PATCH {{baseUrl}}/api/campaign-messages/:id/
Update a campaign message
Rate limits:
Burst: 10/s
Steady: 150/m
Scopes:
campaigns:write
Request Body
{"data"=>{"type"=>"campaign-message", "id"=>"<string>", "attributes"=>{"label"=>"<string>", "content"=>{"subject"=>"<string>", "preview_text"=>"<string>", "from_email"=>"<string>", "from_label"=>"<string>", "reply_to_email"=>"<string>", "cc_email"=>"<string>", "bcc_email"=>"<string>"}, "render_options"=>{"shorten_links"=>true, "add_org_prefix"=>true, "add_info_link"=>true, "add_opt_out_language"=>false}}}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":{"type":"campaign-message","id":"\u003cstring\u003e","attributes":{"label":"\u003cstring\u003e","channel":"\u003cstring\u003e","content":{"subject":"\u003cstring\u003e","preview_text":"\u003cstring\u003e","from_email":"\u003cstring\u003e","from_label":"\u003cstring\u003e","reply_to_email":"\u003cstring\u003e","cc_email":"\u003cstring\u003e","bcc_email":"\u003cstring\u003e"},"send_times":[{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e"},{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e"}],"render_options":{"shorten_links":true,"add_org_prefix":true,"add_info_link":true,"add_opt_out_language":false},"created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"campaign":{"data":{"type":"campaign","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"template":{"data":{"type":"template","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}}