Skip to main content
PATCH
Save CPA projections

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-11-02-1"

Path Parameters

id
string
required

The partner business ID (a coma_ identifier).

Body

application/json
annual_processing_usd
string

Annual projected card and BNPL processing combined, in USD.

Example:

"1200000"

deal_closed_reason
string | null

How the partner closed this business. Send it on its own to save it; the response is then the business ID and the saved reason.

withdraw_projections
boolean

Remove unaccepted projections and invalidate the offer. The original CPA term is retained if projections are later added again.

Response

200 - application/json

CPA projections saved

commission_advance
object | null
required
id
string
required

The referred business relationship ID.

Example:

"coma_xxxxxxxxxxxxxx"