Sign in
Campaigns V2

Update Campaign

Updates a campaign's description or notes. Requires campaigns:write scope.

patch/v2/campaigns/{id}

Path parameters

idstring required

Campaign ID

Campaign ID

Request body

descriptionstring

Description of the campaign

notesstring nullable

Internal notes about the campaign

Response

Success

idstring required

Unique identifier for the campaign

object'campaign' required

Object type, always campaign

application_idstring required

ID of the application this campaign belongs to

descriptionstring required

Description of the campaign

notesstring nullable required

Internal notes about the campaign

is_legacyboolean required

Whether this is a legacy campaign

is_prioritizedboolean required

Whether this campaign is prioritized for config preloading. At most one campaign per application may be prioritized.

created_atstring required

ISO 8601 timestamp of when the campaign was created

updated_atstring required

ISO 8601 timestamp of when the campaign was last updated

archivedboolean required

Whether the campaign is archived

Changes