HIhightouch

Capture a signup

Changed on

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.

post/signups

Request

  • Base URL
    https://api.hightouch.com/api/v1
  • Auth
    HTTP bearer

Request body

traitsSignupTraitsRequest

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

optIn'single' | 'double'

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

sourcestring

Which form or landing page this signup came from.

topicExternalIdentifierstring
topicIdstring

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

channel'email' | 'sms' required

Delivery channels a signup can consent on.

handlestring required

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

Response

Ok

OR

Changes