Update a transactional campaign

post https://api.bigmailer.io/v1/brands/{brand_id}/transactional-campaigns/{campaign_id}

Update a transactional campaign.

Path Params

brand_id

string

required

ID of the brand to update a campaign in

campaign_id

string

required

ID of the campaign

Body Params

name

string

required

Name of the campaign

subject

string

Subject line for the campaign

from

object

recipient_name

string

Name of the recipient. Use merge tags to make it more personal and avoid spam filters.

reply_to

object

link_params

string

Additional query string parameters to add to all links in the template.

preview

string

Copy shown following your subject line in many email clients.

html

string

HTML body of the email.

text

string

Text body of the email.

track_opens

boolean

True to enable open tracking (HTML campaigns only).

track_clicks

boolean

True to enable click tracking in HTML links.

track_text_clicks

boolean

True to enable click tracking in text links.

message_type_id

string

ID of the message type of the campaign.

list_id

string

ID of a list contacts sent the transactional campaign should be added to.

ready

boolean

Set to true to activate the campaign. The campaign cannot be sent until activated by setting ready to true.

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.bigmailer.io/v1/brands/brand_id/transactional-campaigns/campaign_id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The transactional campaign was successfully updated.

400The request was invalid.

401The API key does not exist.

403The system understands the request but refuses to authorize it.

404Campaign does not exist

422The campaign cannot be sent in it's current state. See https://docs.bigmailer.io/docs/campaign-api-precondition-codes for more information.

429The client has made too many requests.

500An unexpected error occurred.

502The system is under heavy load or is down temporarily.

503The system is under maintenance. Please try again later.

504The system timed out processing your request.