Organization API

Create a Campaign

Creates one tenant-scoped Campaign. Requires Idempotency-Key. External References are created transactionally and conflicts return 409. Writes emit campaign.created for webhook subscribers. Required scope: campaigns:write.

/api/v1/campaigns

Create a Campaign. Use an organization API key with campaigns:write. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

campaigns:writeIdempotency-Key required

Parameters

No path or query parameters.

Request body

objectrequired

Field	Type	Description
namerequired	string	Optional unless marked required.
status	string \| null	Optional unless marked required.
type	string \| null	Optional unless marked required.
description	string \| null	Optional unless marked required.
isActive	boolean	Optional unless marked required.
startDate	string \| null	Optional unless marked required.
endDate	string \| null	Optional unless marked required.
budgetedCost	string \| number \| null	Optional unless marked required.
actualCost	string \| number \| null	Optional unless marked required.
expectedRevenue	string \| number \| null	Optional unless marked required.
expectedResponseRate	string \| number \| null	Optional unless marked required.
metadata	object	Optional unless marked required.
externalReferences[]	array<object>	Optional unless marked required.
externalReferences[].externalSystemrequired	string	Optional unless marked required.
externalReferences[].externalObjectrequired	string	Optional unless marked required.
externalReferences[].externalIdrequired	string	Optional unless marked required.
externalReferences[].metadata	object	Optional unless marked required.

createcampaignRequest

{
  "name": "Fall referral campaign",
  "status": "active",
  "type": "referral",
  "isActive": true
}

Responses

201

Created Campaign envelope

#/components/schemas/CampaignEnvelope

400

Validation or idempotency error