Capture a signup
Record a signup: consent for a delivery handle, plus the fields the form collected.
Whether consent settles immediately or waits for a double opt-in confirmation is the channel’s configuration, so one call covers both and the response says which happened.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Delivery channels a signup can consent on.
email, sms Email address or E.164 phone number, matching channel.
A signup's own fields, as collected by the form. They are written to the customer's warehouse and never stored by Hightouch.
Force an opt-in style. Omit to let the topic and channel decide; a value they cannot honor is refused rather than silently resolved.
single, double Which form or landing page this signup came from.
The subscription topic being consented to, by id or external identifier. Omit both to record consent for the channel itself.
Response
Ok
- Option 1
- Option 2
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.
subscribed, doi_pending_confirmation