Skip to main content

Update a Campaign

PATCH 
/campaigns/:id
deprecated

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

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

Request​

Path Parameters

    id stringrequired

    The ID of the campaign template being modified.

    Example: 2c91808571bcfcf80171c23e4b4221fc

Body

arrayrequired

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
  • Array [

    • object

  • ]

Responses​

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

Schema
    id string

    Id of the campaign

    name stringrequired

    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 stringrequired

    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. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response.

    type stringrequired

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

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

    emailNotificationEnabled boolean

    Default value: false

    Enables email notification for this campaign

    autoRevokeAllowed boolean

    Default value: false

    Allows auto revoke for this campaign

    recommendationsEnabled boolean

    Default value: false

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

    created date-time

    Created time of the campaign

    totalCertifications int32

    The total number of certifications in this campaign.

    completedCertifications int32

    The number of completed certifications in this campaign.

    alerts object[]

    A list of errors and warnings that have accumulated.

  • Array [
    • level string

    Possible values: [ERROR, WARN, INFO]

    Denotes the level of the message

    localizations object[]
  • Array [
    • locale stringnullable

    The locale for the message text, a BCP 47 language tag.

    localeOrigin LocaleOriginnullable

    Possible values: [DEFAULT, REQUEST, null]

    An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

    text string

    Actual text of the error message in the indicated locale.

  • ]
  • ]
Loading...