Campaigns

Update a campaign

Rename a campaign, revise its brief, or change its status. Supported status values: archived (soft-delete) and active (restore from archived). Requires 'creator' scope.

patch/v1/campaigns/{id}

Request

  • Base URL: https://api.infiniteaudience.ai
  • URL: https://api.infiniteaudience.ai/v1/campaigns/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

namestring

New display name.

descriptionstring

Campaign brief; send an empty string to clear it.

status'archived' | 'active'

archived — soft-deletes the campaign (excluded from list by default). active — restores a previously archived campaign.

Response

Updated campaign.

idstring required

Unique campaign identifier.

namestring required

Display name of the campaign.

descriptionstring required

User-authored campaign brief, intended market, goals, and constraints.

status'active' | 'archived' required

Lifecycle state of the campaign.

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.