Skip to main content

Update campaign

PATCH 
/v1/partnership/campaigns/:campaign_code

Change the title, description, or archived state of a campaign. An archived campaign cannot be updated. The response returns the campaign after the update; read it again after an unknown write outcome before deciding whether to retry.

Required scopes:

  • write: partnership.all.

Runtime restrictions:

  • The campaign must belong to the partner associated with the API key. Archived campaigns cannot be updated.

Rules:

  • title, when supplied, can contain up to 100 characters.

Rate limits:

  • This operation counts toward the shared limit of 600 requests per 60 seconds per partner, across all of the partner's API keys and all Partnership API operations.

Consistency and recovery notes:

  • The current Partnership API does not provide idempotent-write semantics. After a timeout or connection failure, read the affected resource or list before deciding whether to retry.

Possible errors:

  • Throttled
  • ServiceTransportError
  • Error
  • AuthenticationFailed
  • PermissionDenied
  • ValidationError
  • NotFound
  • NotUnique

Request​

Responses​

Successful response.