Skip to main content
POST
Bulk Set Marketing Consent

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Record one marketing opt-in decision across the selected opportunities.

None leaves that channel's stored answer — including "never asked" — alone, matching apply_marketing_consent.

opportunityIds
string[]
required

IDs of the opportunities to act on

Minimum array length: 1
optedInToSmsMarketing
boolean | null
optedInToEmailMarketing
boolean | null

Response

Successful Response

Aggregate result for a bulk action that fans out per opportunity.

succeeded
integer
default:0

Number of opportunities the action succeeded for

skipped
integer
default:0

Number of opportunities that were already in the requested state

failed
OpportunityBulkActionFailure · object[]

Per-opportunity failures with reasons