Organization API

Update one Campaign

Updates standard Campaign fields and may append External References. No-op PATCH returns changed=false without audit or domain events. Material updates emit campaign.updated. Required scope: campaigns:write.

/api/v1/campaigns/{id}

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

Required scopes

campaigns:write

Parameters

Name	In	Type	Description
idrequired	path	string	Campaign identifier returned by the Organization API.

Request body

objectrequired

Field	Type	Description
name	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.

updatecampaignRequest

{
  "status": "completed",
  "isActive": false
}

Responses

200

Updated Campaign envelope with changed metadata

#/components/schemas/OrgApiResourceEnvelope

400

Validation error