Skip to content

Record an admin-entered consent grant/revoke

Requires EDITOR and TRACKLY_PII_HMAC_KEY.

projectId
required
string

Tenant project id (row-level isolation on every query).

Media typeapplication/json
object
email
required
string format: email
category
required
string
Allowed values: marketing transactional
status
required
string
Allowed values: granted revoked
source
required
string
>= 1 characters <= 200 characters
proof
object
key
additional properties
any

Consent recorded; returns id.

Media typeapplication/json
object
id
string

Request body failed Zod validation.

Media typeapplication/json

Validation error envelope with per-field issues.

object
error
string
issues
Array<object>
object
path
string
message
string
Examplegenerated
json
{
"error": "example",
"issues": [
{
"path": "example",
"message": "example"
}
]
}

Not authenticated (no valid session/principal).

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Authenticated but lacks the required project role.

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

PII HMAC key not configured.

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}