Create a consent record

Settings module

POST/consent-recordsconsentRecords.create

A consent given or withdrawn. Creates a consent record. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability me.account.write.
OAuth scopes: me.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: ConsentRecordCreate

consentRecords.create: ConsentRecordCreate
Field	Type	Required	Description
person_id	string (uuid)	Yes	Identifier of the person.
purpose_code	string	Yes	Consent purpose.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
notice_version	string	Yes	Version of the notice shown when consent was given.Constraints: length 1 to 300
source	"Web" \| "Mobile" \| "Email" \| "SMS" \| "Import" \| "Support"	Yes	Where consent was captured.

{
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "purpose_code": "marketing_email",
  "notice_version": "2026-10-01",
  "source": "Web"
}

Response 201: ConsentRecord

consentRecords.create: ConsentRecord
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the consent record.
created_at	string (date-time)	Yes	When the row was created.
updated_at	string (date-time)	Yes	When the row was last updated.
person_id	string (uuid)	Yes	Identifier of the person.
purpose_code	string	Yes	Consent purpose.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
notice_version	string	Yes	Version of the notice shown when consent was given.Constraints: length 1 to 300
source	"Web" \| "Mobile" \| "Email" \| "SMS" \| "Import" \| "Support"	Yes	Where consent was captured.
captured_at	string (date-time)	Yes	When consent was given, set by the database.
captured_ip	string \| null	Yes	Client IP address at capture, set by the database.Constraints: length 1 to 300
withdrawn_at	string (date-time) \| null	Yes	When the person withdrew consent; null while it stands.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "purpose_code": "marketing_email",
  "notice_version": "2026-10-01",
  "source": "Web",
  "captured_at": "2026-10-08T14:30:00Z",
  "captured_ip": "203.0.113.24",
  "withdrawn_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/consent-records" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","purpose_code":"marketing_email","notice_version":"2026-10-01","source":"Web"}'

const { data } = await xos.consentRecords.create({
    "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "purpose_code": "marketing_email",
    "notice_version": "2026-10-01",
    "source": "Web"
  });

response = xos.consent_records.create({"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "purpose_code": "marketing_email", "notice_version": "2026-10-01", "source": "Web"})

xos consent-records create --data '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","purpose_code":"marketing_email","notice_version":"2026-10-01","source":"Web"}'