martech
campaign

Update a campaign

Changed on
patch/martech/{connection_id}/campaign/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/martech/{connection_id}/campaign/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Campaign

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring

Unique identifier for the campaign

created_atstring date-time

When the campaign was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the campaign was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

Campaign nametitle

typestring

Campaign type (e.g., regular, automation, ab_test)

status'DRAFT' | 'SCHEDULED' | 'SENDING' | 'SENT' | 'CANCELLED' | 'PAUSED' | 'ARCHIVED' | 'OTHER'

Campaign status

list_idsstring[]

Associated listaudience IDs

subject_linestring

Email subject line

preview_textstring

Email preview text

from_namestring

Sender name

from_emailstring

Sender email address

reply_to_emailstring

Reply-to email address

send_atstring date-time

Scheduled send time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rawobject

Raw data from integration

Response

Successful

idstring

Unique identifier for the campaign

created_atstring date-time

When the campaign was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the campaign was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

Campaign nametitle

typestring

Campaign type (e.g., regular, automation, ab_test)

status'DRAFT' | 'SCHEDULED' | 'SENDING' | 'SENT' | 'CANCELLED' | 'PAUSED' | 'ARCHIVED' | 'OTHER'

Campaign status

list_idsstring[]

Associated listaudience IDs

subject_linestring

Email subject line

preview_textstring

Email preview text

from_namestring

Sender name

from_emailstring

Sender email address

reply_to_emailstring

Reply-to email address

send_atstring date-time

Scheduled send time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rawobject

Raw data from integration

Changes

    • info

      added the new optional request property

    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status