Skip to main content

Update Campaign

PUT 
/campaign/:id

Updates the details of an existing campaign​

Use this endpoint to modify campaign properties such as subject line, content, recipients, schedule, or other settings, allowing you to keep campaigns up to date before sending.

  • Campaigns in LAUNCHED / COMPLETED / FAILED status is not allowed to update.
  • sendOrder - omitting the field leaves the order already saved on the campaign alone. Switching to ENGAGEMENT_SCORE is rejected with 400 once the campaign has started building its recipient list: the engagement score is written while that list is built and is never backfilled. Switching to ALPHABETICAL or RANDOM, and restating an order the campaign already has, stay allowed at any point.

Request​

Path Parameters

    id uuidrequired

    ID of the campaign to update

Body

required
    contentSourceUrl string
    campaign object
    name string
    subject string
    previewText string
    senderId uuid
    template object
    html string
    contactIds string[]
    aiTrafficControlId uuid
    sendOrder string

    Possible values: [ALPHABETICAL, RANDOM, ENGAGEMENT_SCORE]

    Order the recipients of a traffic-shaped campaign are sent in.

    • ALPHABETICAL (Standard) - the order every campaign sends in when no order is picked.
    • RANDOM (Shuffled) - a stable pseudo-random order, seeded with the campaign id, so every batch of one send agrees.
    • ENGAGEMENT_SCORE (Most engaged first) - highest engagement score first, lowest and unscored contacts last. Omit the field to keep the standard order. It has no effect on campaigns that are not traffic shaped.
    schedule object
    dateTime string
    days string[]
    time string

Responses​

Successful operation

Loading...