Trigger an API campaign send

Changed on

Start an API-triggered campaign: send to the given recipients.

post/campaigns/{campaignId}/trigger

Request

  • Base URL
    https://api.hightouch.com/api/v1
  • Auth
    HTTP bearer

Path parameters

campaignIdstring required

Request body

propertiesobject

Shared personalization properties applied to all recipients. Keys must match the variable names shown in the message editor. Per-recipient properties take precedence when a key appears in both.

draftboolean

When true, sends the campaign even if it has not been activated. Intended for test sends against draft campaigns only.

Response

Ok

OR

Changes

    • warning

      added the new whatsapp_marketing_us_number enum value to the ////// response property for the response status

    • warning

      added the new invalid_locale enum value to the ////// response property for the response status

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////