ITiterable
campaigns

Trigger a campaign

Trigger a campaign given lists

post/api/campaigns/trigger

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Request body

allowRepeatMarketingSendsboolean

Allow repeat marketing sends? Defaults to true.

campaignIdinteger required
dataFieldsobject

Fields to merge into handlebars context

listIdsinteger[] required

A non-empty array of list IDs to send to

suppressionListIdsinteger[]

Lists to suppress

Response

successful operation

code'Success' | 'BadApiKey' | 'BadAuthorizationHeader' | 'BadJsonBody' | 'BadParams' | 'BatchTooLarge' | 'DatabaseError' | 'EmailAlreadyExists' | 'ExternalKeyConflict' | 'Forbidden' | 'ForbiddenParamsError' | 'ForgottenUserError' | 'GenericError' | 'InvalidEmailAddressError' | 'InvalidJwtPayload' | 'InvalidUserIdError' | 'JwtUserIdentifiersMismatched' | 'NotFound' | 'QueueEmailError' | 'RateLimitExceeded' | 'RequestFieldsTypesMismatched' | 'Unauthorized' | 'UniqueFieldsLimitExceeded' | 'UnknownEmailError' | 'UnknownUserIdError' | 'UserIdAlreadyExists' required
msgstring required

Response description

paramsobject

Additional info

Changes

No recorded changes to this operation across all 4 revisions of this API.