Record Conversion

Record a CONVERSION event with revenue + optional deal back-reference. Feeds ROAS / attribution.

POST/api/v1/marketing/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/marketing/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: RECORD_CONVERSION" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": "string",
    "campaign_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "contact_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "currency_code": "USD",
    "tenant_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  }'

Authorization

Minimum role: ManagerThe caller must hold this role or a higher one.
Action: RECORD_CONVERSION

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be RECORD_CONVERSION for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

amountstringRequired
Revenue tied to the conversion. Required (use RECORD_TOUCH_EVENT for non-revenue funnel events).
campaign_iduuidRequired
No description yet.
contact_idstringRequired
No description yet.
minimum length 1
currency_codestringRequired
No description yet.
minimum length 1
tenant_iduuidRequired
No description yet.
deal_iduuid or nullOptional
No description yet.
metadataanyOptional
No description yet.
occurred_atdate-time or nullOptional
No description yet.
variant_iduuid or nullOptional
A/B variant the converting subject was bucketed into. NULL when the campaign isn't experimental. See RecordTouchEventCommand for the full rationale.

Response

Status 202. The command was applied. The body reports the outcome and, where the command changes a record, that record's new state.

successbooleanRequired
true when the command was applied.
error_messagestringRequired
Empty when the command was applied.
projected_stateobjectOptional
The record as it stands after the command.
event_payloadobjectOptional
The event the command recorded.
insightsarray of objectOptional
Advisory notes about the result. Each has a code, a message and an impact number.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send RECORD_CONVERSION.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below manager or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.