Skip to main content
POST
Import an off-platform marketing opt-in

Authorizations

Authorization
string
header
required

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

Body

application/json
emailAddress
string<email>
required
Maximum string length: 320
Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
source
string
required
Required string length: 1 - 64
originId
string
required
Required string length: 1 - 255
firstName
string
Maximum string length: 100
lastName
string
Maximum string length: 100
postcode

The subscriber's postcode, if the form collected one. Send it as text or a number. We keep it as sent, with no format check. If it is over 20 characters, we leave it out and still save the sign-up. A blank postcode never clears a stored one.

Response

Import an off-platform marketing opt-in

Import an off-platform marketing opt-in

emailAddress
string
required

The normalised address associated with the opt-in event

postcode
string

The postcode stored for this subscriber and organiser, if any.