Create or update existing contact

post

https://api.omnisend.com/api/contacts

Creates a new contact. If a contact with the provided email identifier already exists, it will be updated instead. Returns 201 Created for new contacts and 200 OK when an existing contact was updated.

Scopes: contacts.write

Body Params

Contact to create or update

Payload for creating or updating a contact.

address

string

Street, house number, apartment number.

birthdate

string

Contact birthdate in YYYY-MM-DD format

city

string

City

country

string

Country name. Used to derive ISO country code when countryCode is not provided

countryCode

string

ISO 3166-1 alpha-2 country code. Takes priority over country when both are provided

createdAt

string

Contact creation timestamp. If provided, stored as "externalCreated" custom property

customProperties

object

You can add your own custom properties. Read more in https://api-docs.omnisend.com/reference/contacts#custom-properties

firstName

string

Contact first name

gender

string

enum

Contact gender. m - male, f - female

Allowed:

identifiers

array of objects

Contact identifiers (email and/or phone)

identifiers

lastName

string

Contact last name

postalCode

string

Postal or zip code

state

string

State or region

200Existing contact updated (upsert by email)

201Contact created

400Request contains invalid or missing fields

401Authentication is missing or invalid

403Insufficient permissions for this operation

410API version has been retired

429Rate limit exceeded

500Unexpected error occurred