Skip to main content
POST
Unlink retailer

Authorizations

X-API-Key
string
header
required

Path Parameters

Retailer link ID.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

Everything the top-level view deliberately omits: link date, source, state, and purchase-history-deletion status. Details view only (AC5).

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
retailer_name
string
required

The retailer this link connects to, for display.

coverage_statement
string
required

Honest, non-technical statement of what this link means today. Placeholder pending C-4823 (coverage integrity) -- never implies a protection guarantee this data doesn't support.

status
enum<string>
required

Current lifecycle state of this link.

Available options:
active,
revoked
source
enum<string>
required

How this link was established.

Available options:
manual_enrollment,
redirect
created
string
required

ISO 8601 timestamp the link was first established.

purchase_history_deleted
boolean
required

Whether this consumer has explicitly deleted purchase history for this link.

revoked_at
string | null

ISO 8601 timestamp this consumer unlinked, if unlinked.

purchase_history_deleted_at
string | null

ISO 8601 timestamp purchase history was deleted, if deleted.