Skip to main content
POST
Record consent

Authorizations

Authorization
string
header
required

An API key from the dashboard. sk_live_… sends; sk_test_… validates and returns ids without sending.

Path Parameters

id
string
required
Example:

"ct_01j9x7k2r4m8q3v5n6b7c8d9e0"

Body

application/json
channel
required

One channel, or both.

Available options:
email,
sms
source
enum<string>
required
Available options:
form,
import,
existing_customer,
manual
evidence
object

Up to 4 KB of flat key/values, kept verbatim and shown back; e.g. url, formId, text, ip, userAgent, reference, file, note.

capturedAt
string<date-time>

When the person consented. Defaults to now; not in the future.

Response

The consent rows written, one per channel

id
string
required
Example:

"cns_01j9x7k2r4m8q3v5n6b7c8d9e0"

contactId
string | null
required

Null once the contact was deleted; value stays as the evidence.

channel
enum<string>
required
Available options:
email,
sms
value
string
required

The address or number consent was given for

purpose
string
required
Example:

"marketing"

source
enum<string>
required

How the person agreed. form: a form they submitted. import: a list you brought with consent already obtained. existing_customer: they bought from you and could opt out (POPIA s69(3)). manual: a teammate typed it in. attestation: written by the dashboard when a teammate confirms a list's consent on the Send page.

Available options:
form,
import,
existing_customer,
manual,
attestation
evidence
object | null
required
capturedAt
string<date-time>
required

When the person consented.

recordedAt
string<date-time>
required

When Sendbaze stored it.

revokedAt
string<date-time> | null
required
revokedReason
string | null
required

stop_reply