Generate a Campaign from Template
POST {{baseUrl}}/campaign-templates/:id/generate
Use this API to generate a new certification campaign from a campaign template.
The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign's name/description. Placeholders in those fields are formatted with the current date and time upon generation.
Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, %Y
inserts the current year, and a campaign template named Campaign for %y
generates a campaign called Campaign for 2020
(assuming the year at generation time is 2020).
Valid placeholders are the date/time conversion suffix characters supported by java.util.Formatter.
Calling this endpoint requires the ORG_ADMIN role.
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"id":"ef38f94347e94562b5bb8424a56397d8","name":"Campaign Name","type":"CAMPAIGN","campaignType":"MANAGER","description":"A description of the campaign","correlatedStatus":"CORRELATED","mandatoryCommentRequirement":"NO_DECISIONS"}