Skip to main content
POST
Capture a signup

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
channel
enum<string>
required

Delivery channels a signup can consent on.

Available options:
email,
sms
handle
string
required

Email address or E.164 phone number, matching channel.

traits
object

A signup's own fields, as collected by the form. They are written to the customer's warehouse and never stored by Hightouch.

optIn
enum<string>

Force an opt-in style. Omit to let the topic and channel decide; a value they cannot honor is refused rather than silently resolved.

Available options:
single,
double
source
string

Which form or landing page this signup came from.

topicExternalIdentifier
string
topicId
string

The subscription topic being consented to, by id or external identifier. Omit both to record consent for the channel itself.

Response

Ok

subscribed means consent settled in this request. doi_pending_confirmation means a confirmation was sent and consent settles when the person answers, which may be days later.

status
enum<string>
required
Available options:
subscribed,
doi_pending_confirmation