Update contact

patch

https://api.omnisend.com/v5/contacts/{contactID}

Update an existing contact in the Omnisend system.

Update contact by it's contactID

HTTP Method: PATCH
Endpoint: https://api.omnisend.com/v5/contacts/{contactID}

Update contact by it's email

Endpoint: https://api.omnisend.com/v5/contacts?email={email}
Replace {email} with the actual contact's email.

Updating a Contact

To update a contact, make a PATCH request to the provided endpoint. Only include the fields you want to update for the contact.

Request Parameters

contactID (path parameter):
email (query parameter): The email of the contact in our system.

Updating Fields

Note: Identifiers (identifiers.id value for type phone, email) will be added or updated only if they are not already assigned to another contact.

Scopes: contacts.write
Check POSTMAN documentation

Path Params

contactID

string

required

The unique ID of the contact in our system.

Query Params

string

Email address

Body Params

Contacts to update

address

string

Street, house number, apartment number.

birthdate

string

city

string

contactID

string

country

string

countryCode

string

ISO Country code. You can find all country codes in Guides part.

createdAt

string

Created if not zero will be written to custom property "externalCreated".

customProperties

object

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

firstName

string

gender

string

m - male, f- female

identifiers

array of objects

Identifiers are unique contact identifiers. You can provide multiple identifiers for one contact. For example, you can provide both email and phone number.

identifiers

lastName

string

postalCode

string

Contact's postal or zip code.

sendWelcomeEmail

boolean

Send welcome email (will be sent only if welcome workflow is turned on) or not.

state

string

200Contact updated successfully with the given identifier

400Invalid Contact data

403No permission to update contact