Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

options

AppendOrCreateContactOptions

Appends an existing contact or creates a contact if it doesn't exist.

For internal docs, see
[Submit Contacts](crm.contact-submit-service.introduction).

import { createClient, OAuthStrategy } from '@wix/sdk';
import { submittedContact } from '@wix/crm';

const wixClient = createClient({
  modules: { submittedContact } ,
  auth: OAuthStrategy({ clientId: 'MY-CLIENT-ID' })
});

async function appendOrCreateContact(options) {
  const response = await wixClient.submittedContact.appendOrCreateContact(options);
}

appendOrCreateContact() with visitor/member access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { submittedContact } from '@wix/crm';

const wixClient = createClient({
  modules: { submittedContact },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function appendOrCreateContact(options) {
  const response = await wixClient.submittedContact.appendOrCreateContact(options);
}

appendOrCreateContact() with Dashboard app access

appendOrCreateContact

SubmitContactResponse

To use the SubmittedContact API, install the `@wix/crm` package using npm or Yarn:
  ```console
npm install @wix/crm
```

or

```console
yarn add @wix/crm
```

Then import `{ submittedContact }` from `@wix/crm`:

```js
import { submittedContact } from '@wix/crm'
```
  

crm_submitted-contact

Address

Main address line, usually street and number, as free text.

addressLine

Street address object, with number and name in separate fields.

streetAddress

addressLine1

string

Free text providing more detailed address information,
such as apartment, suite, or floor.

addressLine2

city

2-letter country code in an
[ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.

country

postalCode

Code for a subdivision (such as state, prefecture, or province) in an
[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.

subdivision

AddressTag

Existing Contact ID (optional).
Requires permission `CONTACTS.SUBMIT_WITH_OVERRIDES`

contactId

Contact's information.
To reconcile with an existing contact,
a phone or email must be provided,
or the current session identity must be attached to a contact or member.

If no existing contact can be found,
a new contact is created with the specified information.


Required if there's no contextual identity or given `contactId`.

info

ContactInfo

Pass through data, to be posted on Contact Submitted Domain Event (optional).

passThroughData

ContactAddress

address

Address type.
`UNTAGGED` is shown as "Other" in the Contact List.

ContactAddressesWrapper

items

ContactEmail

email

Indicates whether this is the contact's primary email address.
When changing `primary` to `true` for an email,
the contact's other emails become `false`.
It also affects the subscription status to marketing emails that are decided based on the primary email.

primary

boolean

Email type.

`UNTAGGED` is shown as "Other" in the Contact List.

EmailTag

ContactEmailsWrapper

addresses

Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`.

birthdate

company

emails

Additional custom fields.
This includes fields managed by Wix, by 3rd-party apps, and by the site.

Empty fields are not returned.

extendedFields

ExtendedFieldsWrapper

Contact's job title.
Corresponds to the **Position** field in the Dashboard.

jobTitle

List of contact's labels.
Labels are used to organize contacts.
When setting the `labelKeys` property,
only labels that already exist in the site's Contacts List can be used.
Labels can be added and removed using
[Label Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/label-contact) and
[Unlabel Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/unlabel-contact),
respectively.

To view or manage site labels, use the
[Labels API](https://dev.wix.com/api/rest/contacts/labels).

labelKeys

LabelsWrapper

Locale in
[IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
Typically, this is a lowercase 2-letter language code,
followed by a hyphen, followed by an uppercase 2-letter country code.
For example, `en-US` for U.S. English, and `de-DE` for Germany German.

locale

name

ContactName

phones

ContactPhonesWrapper

picture

ContactPicture

first

last

ContactPhone

[ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.

countryCode

[ITU E.164-formatted](https://www.itu.int/rec/T-REC-E.164/)
phone number.
Automatically generated using `phone` and `countryCode`, pending both values are valid.

e164Phone

phone

Whether this is the contact's primary phone number.
When changing `primary` to `true` for a phone,
the contact's `primary` field for other phones becomes `false`.
It also affects the subscription status to SMS messages that are decided based on the primary phone.

Phone type.

`UNTAGGED` is shown as "Other" in the Contact List.

PhoneTag

Image.
This can contain an image URL or a Wix Media image ID.

image

Contact's extended fields,
where each key is the field key,
and each value is the field's value for the contact.

To view and manage extended fields, use the
[Extended Fields API](https://dev.wix.com/api/rest/contacts/extended-fields).

IdentityType

List of contact label keys.
[Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
help categorize contacts.

Label keys must exist to be added to the contact.
Contact labels can be created or retrieved with
[Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
or
[List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)

StreetAddress

number

ID of the contact that was found or created.

Identity type of the returned contact.

- `CONTACT`: The returned contact ID belongs to a new or existing contact.
- `MEMBER`: The returned contact ID belongs to the currently logged-in site member.
- `NOT_AUTHENTICATED_MEMBER`: The returned contact ID belongs to a site member who is not currently logged in.

identityType

Indicates whether the contact was just created or already existed.

If the contact was just created, returns `true`.
If it already existed, returns `false`.

Setup