Skip to main content

Generate a Campaign from Template

POST 

/campaign-templates/:id/generate

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

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.

Though this Beta endpoint has been deprecated, you can find its V3 equivalent here.

A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.

Request

Responses

This response indicates that a campaign was successfully generated from this template, and the API returns a reference to the new campaign.