Skip to main content
POST
Retract a conversion

Authorizations

Authorization
string
header
required

A workspace API token (sk_live_...) or an OAuth access token (oat_live_...). Create workspace tokens in Settings > API. Send either as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

A unique value (a UUID works) that makes retrying this request safe. A repeat with the same key and body within 24 hours returns the original response instead of acting twice; the same key with a different body is a 409 idempotency_key_reused.

Maximum string length: 255

Path Parameters

conversion_id
string
required

Unique identifier for a conversion.

Pattern: ^cnv_[0-9a-f]{32}$
Example:

"cnv_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

Body

application/json

Body for POST /v1/conversions/{conversion_id}/retract.

reason
string
required

Why it is undone, e.g. the sale was refunded.

Required string length: 1 - 2000
Example:

"Refunded: order-1001"

Response

Successful Response

One conversion.

conversion_key
string
required
created_at
string<date-time>
required

When Sailer recorded the conversion.

dedupe_key
string
required
id
string
required

Unique identifier for a conversion.

Pattern: ^cnv_[0-9a-f]{32}$
Example:

"cnv_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

occurred_at
string<date-time>
required
recorded_by
enum<string>
required

Who recorded it: public_api for this API; Sailer's own producers (system for a deal won, meta_leadgen for a Meta instant form, …) otherwise.

Available options:
meta_leadgen,
entry_link,
tracked_link,
integration,
ai_agent,
user,
automation,
public_api,
system
contact_id
string | null

Unique identifier for a contact.

Pattern: ^con_[0-9a-f]{32}$
Example:

"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

conversation_id
string | null

Unique identifier for a conversation.

Pattern: ^conv_[0-9a-f]{32}$
Example:

"conv_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

currency
string | null

ISO-4217 code of value.

Example:

"BRL"

deal_id
string | null

Unique identifier for a deal.

Pattern: ^deal_[0-9a-f]{32}$
Example:

"deal_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

note
string | null
object
string
default:conversion
Allowed value: "conversion"
retracted_at
string<date-time> | null

When it was retracted. A retracted conversion stays retracted.

retraction_reason
string | null
value
string | null

Value in major units of currency, e.g. 1500.00.