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. Calling this endpoint requires the ORG_ADMIN role.

Request

Path Parameters

    id stringrequired

    ID of the campaign template to use for generation.

    Example: 2c9180835d191a86015d28455b4a2329

Responses

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

Schema
    id stringrequired

    The unique ID of the campaign.

    name stringrequired

    The name of the campaign.

    type stringrequired

    Possible values: [CAMPAIGN]

    The type of object that is being referenced.

    campaignType stringrequired

    Possible values: [MANAGER, SOURCE_OWNER, SEARCH]

    The type of the campaign.

    description stringnullablerequired

    The description of the campaign set by the admin who created it.

    correlatedStatus required

    Possible values: [CORRELATED, UNCORRELATED]

    The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).

    mandatoryCommentRequirement stringrequired

    Possible values: [ALL_DECISIONS, REVOKE_ONLY_DECISIONS, NO_DECISIONS]

    Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.

Loading...