Updates a campaign. The code is immutable and not part of the payload.

PUT

/api/v1/provision/admin/campaigns/{id}

curl --request PUT \
  --url https://example.com/api/v1/provision/admin/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "isEnabled": true, "startsAt": "2026-04-15T12:00:00Z", "endsAt": "2026-04-15T12:00:00Z" }'

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Admin update payload for a campaign. The code is immutable and therefore absent here.

object

name

string

description

null | string

isEnabled

boolean

startsAt

null | string format: date-time

endsAt

null | string format: date-time

Example^generated

{
  "name": "example",
  "description": "example",
  "isEnabled": true,
  "startsAt": "2026-04-15T12:00:00Z",
  "endsAt": "2026-04-15T12:00:00Z"
}

Admin update payload for a campaign. The code is immutable and therefore absent here.

object

name

string

description

null | string

isEnabled

boolean

startsAt

null | string format: date-time

endsAt

null | string format: date-time

Example^generated

{
  "name": "example",
  "description": "example",
  "isEnabled": true,
  "startsAt": "2026-04-15T12:00:00Z",
  "endsAt": "2026-04-15T12:00:00Z"
}

Admin update payload for a campaign. The code is immutable and therefore absent here.

object

name

string

description

null | string

isEnabled

boolean

startsAt

null | string format: date-time

endsAt

null | string format: date-time

Example^generated

{
  "name": "example",
  "description": "example",
  "isEnabled": true,
  "startsAt": "2026-04-15T12:00:00Z",
  "endsAt": "2026-04-15T12:00:00Z"
}

Responses

200

OK

A campaign: a named, time-boxed commercial initiative. Entitlements are attributed to campaigns through touches (issuance, manual attach, plan override, add-on grant), and the campaign performance report rolls results up per campaign.

object

id

string format: uuid

name

string

code

URL-safe identifier embedded in signup links. Immutable after creation.

string

description

null | string

isEnabled

boolean

startsAt

null | string format: date-time

endsAt

null | string format: date-time

isRunning

True when the campaign is enabled and the current time is inside its window.

boolean

creationTimeStamp

string format: date-time

lastUpdateTimeStamp

null | string format: date-time

revisionNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

A campaign: a named, time-boxed commercial initiative. Entitlements are attributed to campaigns through touches (issuance, manual attach, plan override, add-on grant), and the campaign performance report rolls results up per campaign.

object

id

string format: uuid

name

string

code

URL-safe identifier embedded in signup links. Immutable after creation.

string

description

null | string

isEnabled

boolean

startsAt

null | string format: date-time

endsAt

null | string format: date-time

isRunning

True when the campaign is enabled and the current time is inside its window.

boolean

creationTimeStamp

string format: date-time

lastUpdateTimeStamp

null | string format: date-time

revisionNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "code": "example",
  "description": "example",
  "isEnabled": true,
  "startsAt": "2026-04-15T12:00:00Z",
  "endsAt": "2026-04-15T12:00:00Z",
  "isRunning": true,
  "creationTimeStamp": "2026-04-15T12:00:00Z",
  "lastUpdateTimeStamp": "2026-04-15T12:00:00Z",
  "revisionNumber": 1
}

A campaign: a named, time-boxed commercial initiative. Entitlements are attributed to campaigns through touches (issuance, manual attach, plan override, add-on grant), and the campaign performance report rolls results up per campaign.

object

id

string format: uuid

name

string

code

URL-safe identifier embedded in signup links. Immutable after creation.

string

description

null | string

isEnabled

boolean

startsAt

null | string format: date-time

endsAt

null | string format: date-time

isRunning

True when the campaign is enabled and the current time is inside its window.

boolean

creationTimeStamp

string format: date-time

lastUpdateTimeStamp

null | string format: date-time

revisionNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "code": "example",
  "description": "example",
  "isEnabled": true,
  "startsAt": "2026-04-15T12:00:00Z",
  "endsAt": "2026-04-15T12:00:00Z",
  "isRunning": true,
  "creationTimeStamp": "2026-04-15T12:00:00Z",
  "lastUpdateTimeStamp": "2026-04-15T12:00:00Z",
  "revisionNumber": 1
}

400

Bad Request

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}