Skip to main content

Activate a Campaign

Submits a job to activate the campaign with the given Id. The campaign must be staged. Requires roles of CERT_ADMIN and ORG_ADMIN

Path Parameters
  • id string required

    The campaign id

    Example: ef38f94347e94562b5bb8424a56397d8
Request Body

Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.

  • timeZone string

    Default value: Z

    The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh.

Responses

Accepted - Returned if the request was successfully accepted into the system.


Schema
  • object
Loading...