Skip to main content

Update a Campaign

Allows updating individual fields on a campaign using the JSON Patch standard.

Path Parameters
  • id string required

    The ID of the campaign template being modified.

    Example: 2c91808571bcfcf80171c23e4b4221fc
Request Body array required

A list of campaign update operations according to the JSON Patch standard. The fields that can be patched differ based on the status of the campaign.

In the STAGED status, the following fields can be patched:

  • name
  • description
  • recommendationsEnabled
  • deadline
  • emailNotificationEnabled
  • autoRevokeAllowed

In the ACTIVE status, the following fields can be patched:

  • deadline
  • type
Responses

Indicates the PATCH operation succeeded, and returns the campaign's new representation.


Schema
  • id string

    Id of the campaign

  • name string

    The campaign name. If this object is part of a template, special formatting applies; see the /campaign-templates/{id}/generate endpoint documentation for details.

  • description string

    The campaign description. If this object is part of a template, special formatting applies; see the /campaign-templates/{id}/generate endpoint documentation for details.

  • deadline date-time

    The campaign's completion deadline.

  • type string

    Possible values: [MANAGER, SOURCE_OWNER, SEARCH, ROLE_COMPOSITION]

    The type of campaign. Could be extended in the future.

  • emailNotificationEnabled boolean

    Enables email notification for this campaign

  • autoRevokeAllowed boolean

    Allows auto revoke for this campaign

  • recommendationsEnabled boolean

    Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.

  • status string

    Possible values: [PENDING, STAGED, CANCELING, ACTIVATING, ACTIVE, COMPLETING, COMPLETED, ERROR, ARCHIVED]

    The campaign's current status.

  • correlatedStatus string

    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).

Loading...