RelayAPI

Record consent or withdrawal evidence

Consent authority is organization-global for the exact channel, purpose, and normalized recipient identifier. The contact workspace is retained only as evidence provenance.

POST
/v1/contacts/{id}/consents
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

Path Parameters

id*string

Contact ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/contacts/string/consents" \  -H "Content-Type: application/json" \  -d '{    "channel": "string",    "occurred_at": "2019-08-24T14:15:22Z",    "purpose": "string",    "source": "string",    "status": "granted"  }'
{  "channel": "string",  "contact_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "evidence": {    "property1": null,    "property2": null  },  "id": "string",  "identifier_hash": "string",  "identifier_key_version": "string",  "identifier_masked": "string",  "jurisdiction": "string",  "occurred_at": "2019-08-24T14:15:22Z",  "policy_version": "string",  "purpose": "string",  "source": "string",  "status": "granted"}

Found something wrong? Help us improve this page.