Log Conversion

POST

/conversions

• Production
• QA

Log a conversion. 201 when new; 200 with the original row when external_id was already logged.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

What happened. Where it came from (source) is set by the server, never by the caller.

object

campaign_id

Any of:

string

string

<= 100 characters

null

null

campaign_name

Any of:

string

string

<= 255 characters

null

null

company_id

Any of:

integer

integer

>= 1

null

null

contact_email

Any of:

string

string

<= 320 characters

null

null

contact_id

Any of:

integer

integer

>= 1

null

null

currency

Any of:

string

string

<= 16 characters

null

null

custom_label

Any of:

string

string

<= 120 characters

null

null

event_type

required

Signup, demo, purchase, or custom (custom needs custom_label).

string

Allowed values: signup demo purchase custom

external_id

Any of:

string

string

<= 255 characters

null

null

occurred_at

Any of:

string

string format: date-time

null

null

value_cents

Any of:

integer

integer

null

null

Responses

201

Successful Response

object

data

required

object

campaign_id

Any of:

string

string

null

null

campaign_name

Any of:

string

string

null

null

company_id

Any of:

integer

integer

null

null

contact_email

Any of:

string

string

null

null

contact_id

Any of:

integer

integer

null

null

created_at

Any of:

string

string format: date-time

null

null

created_by

Any of:

string

string

null

null

currency

Any of:

string

string

null

null

custom_label

Any of:

string

string

null

null

event_type

required

string

external_id

Any of:

string

string

null

null

id

required

string

occurred_at

required

string format: date-time

source

required

Manual (staff console), api, or workflow.

string

value_cents

Any of:

integer

integer

null

null

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string