Change a campaign. Any change takes an approval away

Before you call

Credential

Authorization: Bearer $KEY

Scope

campaigns:write

Graphql

Mutation.campaignsCampaignUpdate

Sdk

campaigns.campaign.update

Cli

campaigns campaign update

Parameters

• idstring (uuid)required
  In the path

Request bodyapplication/json, required

• namestring
  At most 160 characters.
• kindstring
  One of: broadcast, newsletter. Default: broadcast.
• channelstring
  One of: email, sms, whatsapp. Default: email.
• purposestring
  Default: marketing. Pattern: ^[a-z][a-z0-9_]{0,29}$.
• audienceobject
  • segmentIdstring (uuid)
  • rulesobject
  • tagslist of string
  • excludeSegmentIdslist of string (uuid)
• contentobject
  • subjectstring
    Default: . At most 200 characters.
  • preheaderstring
    At most 200 characters.
  • templateIdstring (uuid)
  • htmlstring
    At most 500000 characters.
  • textstring
    At most 100000 characters.
  • whatsappobject
    • templateIdstringrequired
      At most 80 characters.
    • variablesobject
  • cmsobject
    • typestring
      At most 40 characters.
    • entryIdslist of string (uuid)
    • limitinteger
      At least 1. At most 20.
    • localestring
      At most 20 characters.
  • aiobject
    • generatedbooleanrequired
    • modelstring
      At most 120 characters.
    • runIdstring
      At most 120 characters.
    • disclosureLinestring
      At most 300 characters.
• fromobject
  • namestring
    At most 100 characters.
  • replyTostring
    At most 320 characters.
• variantslist of object
  • idstringrequired
    Pattern: ^[a-z][a-z0-9]{0,9}$.
  • subjectstring
    At most 200 characters.
  • htmlstring
    At most 500000 characters.
  • textstring
    At most 100000 characters.
• abobject
  • testPercentinteger
    Default: 20. At least 5. At most 50.
  • metricstring
    One of: clicks, delivered. Default: clicks.
  • waitHoursnumber
    Default: 4. At least 1. At most 72.
• scheduleobject
  • atstring (date-time)
  • timezonestring
    At most 60 characters.
• throttleobject
  • perHourinteger
    At least 1. At most 1000000.
• recurrenceobject
  • everystringrequired
    One of: day, week, month.
  • atstringrequired
    Pattern: ^\d{2}:\d{2}$.
  • weekdayinteger
    At least 0. At most 6.
  • dayOfMonthinteger
    At least 1. At most 28.
  • timezonestring
    Default: UTC. At most 60 characters.
  • untilstring (date-time)
• trackingobject
  • clicksboolean
    Default: true.
  • opensboolean
    Default: false.

Responses

• 200application/json
  Success

  object

• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring