Contacts

Note:
Before using these API endpoints, learn more about how to use WixHive contacts in your app.
GET/contacts

Returns all contacts that are part of the current site, determined by the application-id and instance-id parameters/headers. The results will be returned in cursored form. By default, all Contacts are returned.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message
GET/contacts/{contactId}

Find a contact referenced by its ID, only relevant for the given site determined by the application-id and instance-id parameters/headers.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

POST/contacts

Version 2.0.0 : Reconciles Contact information with that of the WixHive’s.

Use this when your app has information about a site visitor that may already be registered as a Contact as part of the WixHive. Your app should provide as much information as possible so that we will find the best match for that Contact and return it with the reconciled information. If no match was found, we will create a new Contact.

Depending on the type of information, we will either add or dismiss changes. When the information can be added to a list, such as emails or phones, a new item will be added if no similar item exists. When the information cannot be added we dismiss the change, such is the case with name, company and picture. If your wish is to override such data, there are explicit ways to do so using the Contact’s id and our HTTP API.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

POST/contacts/{contactId}/address

Adds a tag and address to a given Contact. Note: tags are not unique.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status Code
Reason / Error Message
POST/contacts/{contactId}/email

Adds a tag and email to a given Contact. Note: tags are not unique.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status Code
Reason/Error Message
POST/contacts/{contactId}/phone

Adds a tag and phone number to a given Contact. Note: tags are not unique.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

POST/contacts/{contactId}/url

Adds a tag and url to a given Contact. Note: tags are not unique.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

POST/contacts/{contactId}/date

Adds a tag and date to a given Contact. Note: tags are not unique.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

PUT/contacts/{contactId}/name

Edits name information for the given Contact.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

PUT/contacts/{contactId}/company

Edits company information for the given Contact.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

PUT/contacts/{contactId}/address/{addressId}

Edits address information for the given Contact. Note: tags are not unique.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

PUT/contacts/{contactId}/email/{emailId}

Edits email information for the given Contact. Note: tags are not unique.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

PUT/contacts/{contactId}/phone/{phoneId}

Edits phone number information for the given Contact. Note: tags are not unique.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

PUT/contacts/{contactId}/url/{urlId}

Edits url information for the given Contact. Note: tags are not unique.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

PUT/contacts/{contactId}/date/{dateId}

Edits date information for the given Contact. Note: tags are not unique.

Parameters:

NameData TypeParameter TypeDescription

Example:

Response:

Here’s the full list of fields that can be part of the response.

The fields you’ll actually receive depend on the information you request and what we have in the system.

NameTypeDescription

Errors:

Here’s a list of possible errors and when they occur. Read more about our API errors.

HTTP Status CodeReason/Error Message

Was this page helpful?

What can we do to improve it?

What did you like about it?