Skip to main content
POST
Record consent with evidence and an attestation

Authorizations

__Host-lx_session
string
cookie
required

Dashboard session cookie

Body

application/json
e164
string
required
Pattern: ^\+[1-9][0-9]{6,14}$
granted_at
string<date-time>
required
kind
enum<string>
required
Available options:
express,
express_written
scope_type
enum<string>
required
Available options:
tenant,
campaign
source
enum<string>
required
Available options:
api,
web_form,
paper_form,
verbal_recorded,
customer_agreement,
other
attest
boolean

Dashboard callers must attest the evidence is genuine; the server stores who, when, IP and user agent

captured_ip
string
Maximum string length: 45
contact_id
string<uuid>
covers_marketing
boolean

express_written only

evidence_ref
string

One of evidence_ref or evidence_text is required

Maximum string length: 2000
evidence_text
string
Maximum string length: 4000
scope_id
string<uuid>

Campaign id; required when scope_type is campaign

Response

Created

created_at
string<date-time>
required
created_by
string
required
e164
string
required
evidence_sha256
string
required
Pattern: ^[0-9a-f]{64}$
granted_at
string<date-time>
required
id
string<uuid>
required
kind
enum<string>
required
Available options:
express,
express_written
scope_type
enum<string>
required
Available options:
tenant,
campaign
source
enum<string>
required
Available options:
import,
api,
web_form,
paper_form,
verbal_recorded,
customer_agreement,
other
attested_by
string

User or API key that attested the evidence

captured_ip
string
contact_id
string<uuid>
covers
string[]

informational, marketing

evidence_ref
string
evidence_text
string
import_id
string<uuid>
revoked_at
string<date-time>

Latest opt-out recorded after this consent

scope_id
string<uuid>