Create or Update Audience Member

POST

/api/v3/audience

Create or update an audience member for a given organization. Our v3 API requires a company-level API key.

Authorizations

• bearerAuth

Request Body

Media type multipart/form-data

object

CRMID

string

Example

addressLine1

string

Example

addressLine2

string

Example

age

string

Example

allowStatusOverride

When set to true, Letterhead will accept whatever status you pass as part of channelSubscriberStatus. When false, Letterhead introduces a few layers of protection to prevent accidental status changes. For a sure thing, set this to true.

string

Example

false

api

required | When set to true, this endpoint will accept authorization with your API Key.

string

Example

true

attitudes

string

Example

beliefs

string

Example

birthday

string

Example

businessWebsite

string

Example

channelSubscriberStatus

required | The intended subscription status of your audience member. Letterhead will try to protect against accidental status changes, so this needs to be used in conjunction with allowStatusOverride.

string

Example

1

channels[]

required string[]| The slug or the unique identifier of a channel belonging to your organization.

string

Example

{{channelSlug}}

children

string

Example

city

string

Example

contentTopics

string

Example

country

string

Example

customBehavior1

string

Example

customBehavior2

string

Example

customBehavior3

string

Example

customBehavior4

string

Example

customID1

string

Example

customID2

string

Example

customID3

string

Example

customID4

string

Example

customWebProfile1

string

Example

customWebProfile2

string

Example

customWebProfile3

string

Example

customWebProfile4

string

Example

deliveryPreference

string

Example

education

string

Example

email

required | The email address of your audience member.

string

Example

[email protected]

ethnicity

string

Example

events

string

Example

facebookProfileName

string

Example

gender

string

Example

githubProfileName

string

Example

googleProfileName

string

Example

homePhone

string

Example

honorific

string

Example

instagramProfileName

string

Example

interests

string

Example

jobCompanyOrOrganizationName

string

Example

jobTitle

string

Example

language

string

Example

latitude

string

Example

linkedInProfileName

string

Example

longitude

string

Example

maritalStatus

string

Example

memberStatus

string

Example

memberStatusChangedDate

string

Example

mobilePhone

string

Example

mostEngagedSources

string

Example

mostEngagedTopics

string

Example

name

string

Example

notes

string

Example

pets

string

Example

politicalAffiliation

string

Example

postalCode

string

Example

pronouns

string

Example

purchases

string

Example

race

string

Example

referralSource

string

Example

referralStatus

string

Example

referredByEmail

string

Example

referredByFirstName

string

Example

referredByLastName

string

Example

region

string

Example

religion

string

Example

sexualOrientation

string

Example

snapchatProfileName

string

Example

stateProvince

string

Example

suffix

string

Example

surname

string

Example

tikTokProfileName

string

Example

timeZone

string

Example

twitterProfileName

string

Example

website

string

Example

websiteProfileName

string

Example

welcome

When set to true, trigger a Welcome email when a new audience member is added. The “Welcome” automation must be configured in a given channel. Note that when true this will send regardless of the audience member’s subscription status.

string

Example

false

workPhone

string

Example

Responses

200