ECecomail
Campaigns

Update campaign

Changed on

Update an existing campaign.

put/campaigns/{campaign_id}

Request

  • Base URL
    https://api2.ecomailapp.cz
  • URL
    https://api2.ecomailapp.cz/campaigns/{campaign_id}
  • Auth
    API key in header key

Path parameters

campaign_idinteger required

Campaign ID.

Request body

titlestring required

Campaign title. Maximum 255 characters.

from_namestring

Sender's name. Maximum 150 characters. Send null to clear it.

from_emailstring

Sender's email address.

reply_tostring

Reply-to email address.

subjectstring

Campaign subject line. Maximum 255 characters. Send null to clear it.

preheaderstring

Preheader text shown after the subject line in the inbox. Maximum 255 characters. Send null to clear it.

gastring

Google Analytics campaign name. Send null to clear it.

html_textstring

HTML content of the campaign. When you send it, it must not be empty.

template_idinteger

ID of a template to copy into the campaign. The template content replaces the campaign content. When you send the ID of the template the campaign already uses, the campaign content stays unchanged.

campaign_typestring

Campaign type. Allowed values: email, sms, whatsapp, push_notification. Your account must have the channel enabled, otherwise the request fails with 403.

Response

OK

idinteger
titlestring
from_namestring
from_emailstring
reply_tostring
subjectstring
template_typestring
campaign_typestring
updated_atstring
created_atstring
archive_urlstring

Changes

  • 463706880cfdRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status