Creates a campaign. The code becomes immutable and is embedded in signup links.
const url = 'https://example.com/api/v1/provision/admin/campaigns';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"name":"example","code":"example","description":"example","isEnabled":true,"startsAt":"2026-04-15T12:00:00Z","endsAt":"2026-04-15T12:00:00Z"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/provision/admin/campaigns \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "code": "example", "description": "example", "isEnabled": true, "startsAt": "2026-04-15T12:00:00Z", "endsAt": "2026-04-15T12:00:00Z" }'Request Bodyrequired
Section titled “Request Bodyrequired”Admin request to create a campaign.
object
URL-safe identifier embedded in signup links (?campaign=CODE): lowercase letters,
digits, and hyphens, up to 64 characters. Immutable after creation.
Master switch. A campaign that is switched off is not running, whatever its window says.
When the campaign starts running; null starts it immediately.
When the campaign stops running; null runs it without an end date.
Examplegenerated
{ "name": "example", "code": "example", "description": "example", "isEnabled": true, "startsAt": "2026-04-15T12:00:00Z", "endsAt": "2026-04-15T12:00:00Z"}Admin request to create a campaign.
object
URL-safe identifier embedded in signup links (?campaign=CODE): lowercase letters,
digits, and hyphens, up to 64 characters. Immutable after creation.
Master switch. A campaign that is switched off is not running, whatever its window says.
When the campaign starts running; null starts it immediately.
When the campaign stops running; null runs it without an end date.
Examplegenerated
{ "name": "example", "code": "example", "description": "example", "isEnabled": true, "startsAt": "2026-04-15T12:00:00Z", "endsAt": "2026-04-15T12:00:00Z"}Admin request to create a campaign.
object
URL-safe identifier embedded in signup links (?campaign=CODE): lowercase letters,
digits, and hyphens, up to 64 characters. Immutable after creation.
Master switch. A campaign that is switched off is not running, whatever its window says.
When the campaign starts running; null starts it immediately.
When the campaign stops running; null runs it without an end date.
Examplegenerated
{ "name": "example", "code": "example", "description": "example", "isEnabled": true, "startsAt": "2026-04-15T12:00:00Z", "endsAt": "2026-04-15T12:00:00Z"}Responses
Section titled “Responses”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
URL-safe identifier embedded in signup links. Immutable after creation.
True when the campaign is enabled and the current time is inside its window.
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
URL-safe identifier embedded in signup links. Immutable after creation.
True when the campaign is enabled and the current time is inside its window.
Examplegenerated
{ "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
URL-safe identifier embedded in signup links. Immutable after creation.
True when the campaign is enabled and the current time is inside its window.
Examplegenerated
{ "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}Bad Request
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}