Skip to main content
POST
Grant consent for a topic

Authorizations

X-API-Key
string
header
required

Project-scoped API key, format rm_(live|test)_... . May also be sent as Authorization: Bearer rm_....

Path Parameters

email
string<email>
required

URL-encoded subscriber email.

Body

application/json
topicKey
string
required
source
string
required
ipAddress
string | null
userAgent
string | null
sourceUrl
string | null
formVersion
string | null

Response

Consent granted (or pending confirmation for double opt-in topics)

When requiresConfirmation is true, the topic uses double opt-in and the subscriber must confirm via email before they are subscribed.

topicKey
string
status
string

e.g. SUBSCRIBED, PENDING_CONFIRMATION, UNSUBSCRIBED.

requiresConfirmation
boolean
grantedAt
string<date-time> | null
confirmedAt
string<date-time> | null
tokenExpiresAt
string<date-time> | null