{"id":"7cf315ff-38ec-474a-ae44-7f562bcb993b","createdDate":"2025-01-21T11:21:53.950Z","updatedDate":"2025-01-21T11:21:53.950Z","resourceId":"28ef8192-e99f-4bd3-b1ce-1af9b46316a7","sdk":{"schema":{"name":"velo_wix-crm-backend","fqn":"","slug":"velo-wix-crm-backend","typesMap":{"ContactInfo":{"name":"ContactInfo","fqn":"ContactInfo","slug":"contact-info","actions":[],"properties":[{"name":"customFields","slug":"custom-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"UNION","types":[{"kind":"PRIMITIVE","name":"string"},{"kind":"PRIMITIVE","name":"number"},{"kind":"DATE"}]},"description":"Any\r\n number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)\r\n are used to store additional information about your site's contacts. When\r\n setting a custom field, use key:value pairs, where the key matches the display names\r\n in your site's [Contacts List](https://support.wix.com/en/article/accessing-your-contact-list).\r\n You can only set values for custom fields that already exist in the Contacts\r\n application."},{"name":"emails","slug":"emails","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of contact's email addresses. When\r\n creating a contact, if no phone number is\r\n provided, at least one email address must be provided."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's first name."},{"name":"labels","slug":"labels","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of contact's labels. [Labels](https://support.wix.com/en/article/creating-contact-labels)\r\n are used to organize contacts. When setting the `labels` property, you can\r\n only list labels that already exist in your site's [Contacts List](https://support.wix.com/en/article/accessing-your-contact-list)."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's last name."},{"name":"loginEmail","slug":"login-email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email address the contact who is also\r\n a member uses to log into the system."},{"name":"phones","slug":"phones","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of contact's phone numbers. When\r\n creating a contact, if no email is\r\n provided, at least one phone number must be provided."},{"name":"picture","slug":"picture","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's image source."}]},"DeleteOptions":{"name":"DeleteOptions","fqn":"DeleteOptions","slug":"delete-options","actions":[],"properties":[{"name":"deleteMembers","slug":"delete-members","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to perform the deletion when the contact is also a member. Defaults to `false`."}]},"TriggeredEmails.TriggeredEmailOptions":{"name":"TriggeredEmailOptions","fqn":"TriggeredEmails.TriggeredEmailOptions","slug":"triggered-email-options","actions":[],"properties":[{"name":"variables","slug":"variables","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"An object with `key:value` pairs. Each\r\n `key` is a variable in the email template created in Triggered Emails, and its\r\n corresponding `value` is the value to insert into the template in place of the\r\n variable. The values must be strings.\r\n\r\nExample: `{ firstName: 'John', lastName: 'Doe' }`"}]},"Contacts.ContactInfo":{"name":"ContactInfo","fqn":"Contacts.ContactInfo","slug":"contact-info","actions":[],"properties":[{"name":"addresses","slug":"addresses","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AddressInfo","referenceFqn":"Contacts.AddressInfo"}},"description":"List of up to 50 addresses."},{"name":"birthdate","slug":"birthdate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's birthdate, formatted as `\"YYYY-MM-DD\"`.\r\n\r\n Example: `\"2020-03-15\"` for March 15, 2020."},{"name":"company","slug":"company","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's company name."},{"name":"emails","slug":"emails","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"EmailInfo","referenceFqn":"Contacts.EmailInfo"}},"description":"List of up to 50 email addresses."},{"name":"extendedFields","slug":"extended-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"Set of key-value pairs.\r\n\r\n\r\n\r\nContact's\r\n[extended fields](https://www.wix.com/velo/reference/wix-crm-v2/extendedfields/introduction),\r\nwhich allow you to store additional information about your contacts.\r\n\r\nTo view or create extended fields, use\r\n[`findOrCreateExtendedField()`](wix-crm-backend/contacts/findorcreateextendedfield),\r\n[`getExtendedField()`](wix-crm-backend/contacts/getextendedfield), or\r\n[`queryExtendedFields()`](wix-crm-backend/contacts/queryextendedfields)."},{"name":"jobTitle","slug":"job-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's job title.\r\n Corresponds to the **Position** field in the Dashboard."},{"name":"labelKeys","slug":"label-keys","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of contact label keys.\r\n[Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)\r\nhelp categorize contacts.\r\n\r\n\r\n\r\n\r\nLabel keys must exist to be added to the contact.\r\nContact labels can be created or retrieved with\r\n[`findOrCreateLabel()`](wix-crm-backend/contacts/findorcreatelabel)\r\nor\r\n[`queryLabels()`](wix-crm-backend/contacts/queryLabels)."},{"name":"locale","slug":"locale","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's locale, formatted as an\r\n [IETF BCP 47 language tag](https://tools.ietf.org/html/rfc5646).\r\n Typically, this is a lowercase 2-letter language code,\r\n followed by a hyphen,\r\n followed by an uppercase 2-letter country code.\r\n\r\n For example, German from Germany is formatted as `de-DE`,\r\n and U.S. English is formatted as `en-US`."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Name","referenceFqn":"Contacts.Name"},"description":"Contact's first and last name."},{"name":"phones","slug":"phones","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"PhoneInfo","referenceFqn":"Contacts.PhoneInfo"}},"description":"List of up to 50 phone numbers."},{"name":"picture","slug":"picture","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Picture","referenceFqn":"Contacts.Picture"},"description":"**Deprecated.** Use `profilePicture` instead."},{"name":"profilePicture","slug":"profile-picture","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's profile picture URL."}]},"Contacts.AddressInfo":{"name":"AddressInfo","fqn":"Contacts.AddressInfo","slug":"address-info","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressDetails","referenceFqn":"Contacts.AddressDetails"},"description":"Street address."},{"name":"tag","slug":"tag","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Address type.\r\n`\"UNTAGGED\"` is shown as \"Other\" in the Contact List.\r\n\r\nOne of:\r\n\r\n- `\"UNTAGGED\"`\r\n- `\"HOME\"`\r\n- `\"WORK\"`\r\n- `\"BILLING\"`\r\n- `\"SHIPPING\"`"}]},"Contacts.AddressDetails":{"name":"AddressDetails","fqn":"Contacts.AddressDetails","slug":"address-details","actions":[],"oneofProperties":{"addressDetailsStreet":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line, usually street and number, as free text."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddressInfo","referenceFqn":"Contacts.StreetAddressInfo"},"description":"Street address object, with number and name in separate fields."}]},"properties":[{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text providing more detailed address information,\r\n such as apartment, suite, or floor."},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"City name."},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"2-letter country code in an\r\n [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format."},{"name":"formatted","slug":"formatted","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Human-readable address string.\r\n If not provided, the value is generated from the available address data."},{"name":"location","slug":"location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressLocation","referenceFqn":"Contacts.AddressLocation"},"description":"Coordinates of the physical address."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Postal or zip code."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Code for a subdivision (such as state, prefecture, or province) in an\r\n [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format."}]},"Contacts.AddressLocation":{"name":"AddressLocation","fqn":"Contacts.AddressLocation","slug":"address-location","actions":[],"properties":[{"name":"latitude","slug":"latitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address's latitude."},{"name":"longitude","slug":"longitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address's longitude."}]},"Contacts.StreetAddressInfo":{"name":"StreetAddressInfo","fqn":"Contacts.StreetAddressInfo","slug":"street-address-info","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street name."},{"name":"number","slug":"number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street number."}]},"Contacts.EmailInfo":{"name":"EmailInfo","fqn":"Contacts.EmailInfo","slug":"email-info","actions":[],"properties":[{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email address."},{"name":"primary","slug":"primary","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates whether this is the contact's primary email address.\r\n When changing `primary` to `true` for an email,\r\n the contact's other emails become `false`."},{"name":"tag","slug":"tag","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email type.\r\n\r\n\r\n\r\n\r\n`\"UNTAGGED\"` is shown as \"Other\" in the Contact List.\r\n\r\nOne of:\r\n\r\n- `\"UNTAGGED\"`\r\n- `\"MAIN\"`\r\n- `\"HOME\"`\r\n- `\"WORK\"`"}]},"Contacts.Name":{"name":"Name","fqn":"Contacts.Name","slug":"name","actions":[],"properties":[{"name":"first","slug":"first","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's first name."},{"name":"last","slug":"last","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's last name."}]},"Contacts.PhoneInfo":{"name":"PhoneInfo","fqn":"Contacts.PhoneInfo","slug":"phone-info","actions":[],"properties":[{"name":"countryCode","slug":"country-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"[ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Phone number."},{"name":"primary","slug":"primary","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether this is the contact's primary phone number.\r\n When changing `primary` to `true` for a phone,\r\n the contact's other phones become `false`."},{"name":"tag","slug":"tag","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Phone type.\r\n\r\n\r\n\r\n\r\n`\"UNTAGGED\"` is shown as \"Other\" in the Contact List.\r\n\r\nOne of:\r\n\r\n- `\"UNTAGGED\"`\r\n- `\"MAIN\"`\r\n- `\"HOME\"`\r\n- `\"MOBILE\"`\r\n- `\"WORK\"`\r\n- `\"FAX\"`"}]},"Contacts.Picture":{"name":"Picture","fqn":"Contacts.Picture","slug":"picture","actions":[],"properties":[{"name":"image","slug":"image","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"string"},"description":"**Deprecated.** Use `profilePicture` instead."},{"name":"imageProvider","slug":"image-provider","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"string"},"description":"**Deprecated.**"}]},"Contacts.ContactIdentification":{"name":"ContactIdentification","fqn":"Contacts.ContactIdentification","slug":"contact-identification","actions":[],"properties":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the contact that was found or created."},{"name":"identityType","slug":"identity-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Identity type of the returned contact.\r\n\r\n\r\n\r\n\r\nOne of:\r\n\r\n- `\"CONTACT\"`: The returned contact ID belongs to a new or existing contact.\r\n- `\"MEMBER\"`: The returned contact ID belongs to the currently logged-in site member.\r\n- `\"NOT_AUTHENTICATED_MEMBER\"`: The returned contact ID belongs to a site member who is not currently logged in."}]},"Contacts.Options":{"name":"Options","fqn":"Contacts.Options","slug":"options","actions":[],"properties":[{"name":"allowDuplicates","slug":"allow-duplicates","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Controls whether the call will succeed\r\nif the new contact information contains an email already used by another contact.\r\n\r\nIf set to `true`,\r\nthe call will succeed even if an email address is used by another contact.\r\nIf set to `false`,\r\nthe call will fail if an email address is used by another contact.\r\n\r\nDefaults to `false`."},{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, prevents permission checks from running for the operation. Defaults to `false`."}]},"Contacts.Contact":{"name":"Contact","fqn":"Contacts.Contact","slug":"contact","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the contact was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID."},{"name":"_updatedDate","slug":"updated-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the contact was last updated."},{"name":"info","slug":"info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Info","referenceFqn":"Contacts.Info"},"description":"Contact's details."},{"name":"lastActivity","slug":"last-activity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LastActivity","referenceFqn":"Contacts.LastActivity"},"description":"Details about the contact's last action in the site."},{"name":"primaryInfo","slug":"primary-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PrimaryInfo","referenceFqn":"Contacts.PrimaryInfo"},"description":"Contact's primary phone and email."},{"name":"revision","slug":"revision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Revision number, which increments by 1 each time the contact is updated.\r\n To prevent conflicting changes,\r\n the existing `revision` must be used when updating a contact."},{"name":"source","slug":"source","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Source","referenceFqn":"Contacts.Source"},"description":"Details about the contact's source."}]},"Contacts.Info":{"name":"Info","fqn":"Contacts.Info","slug":"info","actions":[],"properties":[{"name":"addresses","slug":"addresses","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Address","referenceFqn":"Contacts.Address"}},"description":"List of up to 50 addresses."},{"name":"birthdate","slug":"birthdate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's birthdate, formatted as `\"YYYY-MM-DD\"`.\r\n\r\n Example: `\"2020-03-15\"` for March 15, 2020."},{"name":"company","slug":"company","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's company name."},{"name":"emails","slug":"emails","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Email","referenceFqn":"Contacts.Email"}},"description":"List of up to 50 email addresses."},{"name":"extendedFields","slug":"extended-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"Set of key-value pairs.\r\n\r\n\r\n\r\nContact's\r\n[extended fields](https://www.wix.com/velo/reference/wix-crm-v2/extendedfields/introduction),\r\nwhich allow you to store additional information about your contacts.\r\n\r\nTo view or create extended fields, use\r\n[`findOrCreateExtendedField()`](wix-crm-backend/contacts/findorcreateextendedfield),\r\n[`getExtendedField()`](wix-crm-backend/contacts/getextendedfield), or\r\n[`queryExtendedFields()`](wix-crm-backend/contacts/queryextendedfields)."},{"name":"jobTitle","slug":"job-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's job title.\r\n Corresponds to the **Position** field in the Dashboard."},{"name":"labelKeys","slug":"label-keys","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of contact label keys.\r\n[Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)\r\nhelp categorize contacts.\r\n\r\n\r\n\r\n\r\nLabel keys must exist to be added to the contact.\r\nContact labels can be created or retrieved with\r\n[`findOrCreateLabel()`](wix-crm-backend/contacts/findorcreatelabel)\r\nor\r\n[`queryLabels()`](wix-crm-backend/contacts/queryLabels)."},{"name":"locale","slug":"locale","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's locale, formatted as an\r\n [IETF BCP 47 language tag](https://tools.ietf.org/html/rfc5646).\r\n Typically, this is a lowercase 2-letter language code,\r\n followed by a hyphen,\r\n followed by an uppercase 2-letter country code.\r\n\r\n For example, German from Germany is formatted as `de-DE`,\r\n and U.S. English is formatted as `en-US`."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Name","referenceFqn":"Contacts.Name"},"description":"Contact's first and last name."},{"name":"phones","slug":"phones","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Phone","referenceFqn":"Contacts.Phone"}},"description":"List of up to 50 phone numbers."},{"name":"picture","slug":"picture","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"REFERENCE","name":"Picture","referenceFqn":"Contacts.Picture"},"description":"**Deprecated.** Use `profilePicture` instead."},{"name":"profilePicture","slug":"profile-picture","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's profile picture URL."}]},"Contacts.Address":{"name":"Address","fqn":"Contacts.Address","slug":"address","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street address ID."},{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressDetails","referenceFqn":"Contacts.AddressDetails"},"description":"Street address."},{"name":"tag","slug":"tag","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Address type.\r\n`\"UNTAGGED\"` is shown as \"Other\" in the Contact List.\r\n\r\nOne of:\r\n\r\n- `\"UNTAGGED\"`\r\n- `\"HOME\"`\r\n- `\"WORK\"`\r\n- `\"BILLING\"`\r\n- `\"SHIPPING\"`"}]},"Contacts.Email":{"name":"Email","fqn":"Contacts.Email","slug":"email","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email ID."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email address."},{"name":"primary","slug":"primary","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates whether this is the contact's primary email address.\r\n When changing `primary` to `true` for an email,\r\n the contact's other emails become `false`."},{"name":"tag","slug":"tag","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email type.\r\n\r\n\r\n\r\n\r\n`\"UNTAGGED\"` is shown as \"Other\" in the Contact List.\r\n\r\nOne of:\r\n\r\n- `\"UNTAGGED\"`\r\n- `\"MAIN\"`\r\n- `\"HOME\"`\r\n- `\"WORK\"`"}]},"Contacts.Phone":{"name":"Phone","fqn":"Contacts.Phone","slug":"phone","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Phone ID."},{"name":"countryCode","slug":"country-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"[ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code."},{"name":"e164Phone","slug":"e164phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"[ITU E.164-formatted](https://www.itu.int/rec/T-REC-E.164/)\r\n phone number.\r\n Automatically generated using `phone` and `countryCode`,\r\n as long as both of those values are valid."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Phone number."},{"name":"primary","slug":"primary","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether this is the contact's primary phone number.\r\n When changing `primary` to `true` for a phone,\r\n the contact's other phones become `false`."},{"name":"tag","slug":"tag","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Phone type.\r\n\r\n\r\n\r\n\r\n`\"UNTAGGED\"` is shown as \"Other\" in the Contact List.\r\n\r\nOne of:\r\n\r\n- `\"UNTAGGED\"`\r\n- `\"MAIN\"`\r\n- `\"HOME\"`\r\n- `\"MOBILE\"`\r\n- `\"WORK\"`\r\n- `\"FAX\"`"}]},"Contacts.LastActivity":{"name":"LastActivity","fqn":"Contacts.LastActivity","slug":"last-activity","actions":[],"properties":[{"name":"activityDate","slug":"activity-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time of the last action."},{"name":"activityType","slug":"activity-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact's last action in the site.\r\n\r\n\r\n\r\n\r\nSome possible values:\r\n`\"GENERAL\"`, `\"CONTACT_CREATED\"`, `\"MEMBER_LOGIN\"`, `\"MEMBER_REGISTER\"`,\r\n`\"MEMBER_STATUS_CHANGED\"`, `\"FORM_SUBMITTED\"`, `\"INBOX_FORM_SUBMITTED\"`,\r\n`\"INBOX_PAYMENT_REQUEST_PAID\"`, `\"INBOX_MESSAGE_TO_CUSTOMER\"`,\r\n`\"INBOX_MESSAGE_FROM_CUSTOMER\"`, `\"NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED\"`,\r\n`\"NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE\"`, `\"ECOM_PURCHASE\"`,\r\n`\"ECOM_CART_ABANDON\"`, `\"ECOM_CHECKOUT_BUYER\"`, `\"BOOKINGS_APPOINTMENT\"`,\r\n`\"HOTELS_RESERVATION\"`, `\"HOTELS_PURCHASE\"`, `\"HOTELS_CONFIRMATION\"`,\r\n`\"HOTELS_CANCEL\"`, `\"VIDEO_PURCHASE\"`, `\"VIDEO_RENT\"`,\r\n`\"CASHIER_BUTTON_PURCHASE\"`, `\"ARENA_NEW_LEAD\"`, `\"EVENTS_RSVP\"`,\r\n`\"INVOICE_PAY\"`, `\"INVOICE_OVERDUE\"`, `\"PRICE_QUOTE_ACCEPT\"`,\r\n`\"PRICE_QUOTE_EXPIRE\"`, `\"RESTAURANTS_ORDER\"`, `\"RESTAURANTS_RESERVATION\"`,\r\n`\"SHOUTOUT_OPEN\"`, `\"SHOUTOUT_CLICK\"`, `\"CONTACT_MERGED\"`."}]},"Contacts.PrimaryInfo":{"name":"PrimaryInfo","fqn":"Contacts.PrimaryInfo","slug":"primary-info","actions":[],"properties":[{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Primary email address.\r\n\r\n\r\n\r\n\r\nThis property reflects the email address in `contactInfo.emails`\r\nwhere `primary` is `true`."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Primary phone number.\r\n\r\n\r\n\r\n\r\nThis property reflects the phone number in `contactInfo.phones`\r\nwhere `primary` is `true`."}]},"Contacts.Source":{"name":"Source","fqn":"Contacts.Source","slug":"source","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"App ID, if the contact was created by an app."},{"name":"sourceType","slug":"source-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Source type.\r\n\r\n\r\nSome possible values:\r\n`\"OTHER\"`, `\"ADMIN\"`, `\"WIX_APP\"`, `\"IMPORT\"`, `\"THIRD_PARTY\"`,\r\n`\"WIX_BOOKINGS\"`, `\"WIX_CHAT\"`, `\"WIX_EMAIL_MARKETING\"`, `\"WIX_EVENTS\"`,\r\n`\"WIX_FORMS\"`, `\"WIX_GROUPS\"`, `\"WIX_HOTELS\"`, `\"WIX_MARKET_PLACE\"`,\r\n`\"WIX_MUSIC\"`, `\"WIX_RESTAURANTS\"`, `\"WIX_SITE_MEMBERS\"`, `\"WIX_STORES\"`."}]},"Contacts.AuthOptions":{"name":"AuthOptions","fqn":"Contacts.AuthOptions","slug":"auth-options","actions":[],"properties":[{"name":"suppressAuth","slug":"suppress-auth","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"When `true`, prevents permission checks from running for the operation. Defaults to `false`."}]},"Contacts.ExtendedFieldInfo":{"name":"ExtendedFieldInfo","fqn":"Contacts.ExtendedFieldInfo","slug":"extended-field-info","actions":[],"properties":[{"name":"dataType","slug":"data-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Type of data the field holds.\r\nIgnored if an existing field is an exact match\r\nfor the specified display name.\r\n\r\n\r\n\r\n\r\nOne of:\r\n\r\n- `\"TEXT\"`: Accepts strings.\r\n- `\"URL\"`: Accepts web addresses. Prepends `https://` if no protocol is included.\r\n- `\"DATE\"`: Accepts dates formatted as `\"YYYY-MM-DD\"`.\r\n- `\"NUMBER\"`: Accepts floats."},{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Display name to find or create.\r\n\r\n If an existing custom field is an exact match\r\n for the specified `displayName`,\r\n the existing field is returned.\r\n If not, a new field is created and returned."}]},"Contacts.FoundOrCreatedExtendedField":{"name":"FoundOrCreatedExtendedField","fqn":"Contacts.FoundOrCreatedExtendedField","slug":"found-or-created-extended-field","actions":[],"properties":[{"name":"extendedField","slug":"extended-field","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExtendedField","referenceFqn":"Contacts.ExtendedField"},"description":"Extended field that was found or created."},{"name":"newExtendedField","slug":"new-extended-field","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates whether the extended field was just created or already existed.\r\n\r\n If the field was just created, returns `true`.\r\n If it already existed, returns `false`."}]},"Contacts.ExtendedField":{"name":"ExtendedField","fqn":"Contacts.ExtendedField","slug":"extended-field","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the field was created."},{"name":"_updatedDate","slug":"updated-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the field was last updated."},{"name":"dataType","slug":"data-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Type of data the field holds.\r\n\r\n\r\n\r\n\r\nOne of:\r\n\r\n- `\"TEXT\"`: Accepts strings.\r\n- `\"URL\"`: Accepts web addresses. Prepends `https://` if no protocol is included.\r\n- `\"DATE\"`: Accepts dates formatted as `\"YYYY-MM-DD\"`.\r\n- `\"NUMBER\"`: Accepts floats."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Field description, if the field is a system field."},{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Extended field display name shown in the Contact List."},{"name":"fieldType","slug":"field-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Indicates whether the extended field is a\r\n[system field or custom field](wix-crm-backend/contacts/introduction#about-extended-fields).\r\n\r\nOne of:\r\n\r\n- `\"SYSTEM\"`: The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.\r\n- `\"USER_DEFINED\"`: The field is a custom field and can be modified by 3rd-party apps or site contributors."},{"name":"key","slug":"key","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Extended field ID.\r\n\r\nWhen accessing contact data,\r\nextended field data is available at `extendedFields[key]`.\r\nFor example, if the key is \"custom.notes\",\r\nthe value can be accessed at `extendedFields[\"custom.notes\"]`.\r\n\r\n`key` is generated when the extended field is created\r\nand cannot be modified, even if `displayName` changes."},{"name":"namespace","slug":"namespace","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Extended field [namespace](wix-crm-backend/contacts/introduction#the-namespace-and-key-properties-in-labels-and-extended-fields).\r\n\r\n\r\nExtended fields created by site contributors or 3rd-party apps\r\nare automatically assigned to the `custom` namespace."}]},"Contacts.FoundOrCreatedLabel":{"name":"FoundOrCreatedLabel","fqn":"Contacts.FoundOrCreatedLabel","slug":"found-or-created-label","actions":[],"properties":[{"name":"label","slug":"label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Label","referenceFqn":"Contacts.Label"},"description":"Label that was found or created."},{"name":"newLabel","slug":"new-label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates whether the label was just created or already existed.\r\n\r\n If the label was just created, returns `true`.\r\n If it already existed, returns `false`."}]},"Contacts.Label":{"name":"Label","fqn":"Contacts.Label","slug":"label","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the label was created."},{"name":"_updatedDate","slug":"updated-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the label was last updated."},{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Label display name shown in the Dashboard."},{"name":"key","slug":"key","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Label key.\r\n\r\n`key` is generated when the label is created\r\nand cannot be modified, even if `displayName` changes."},{"name":"labelType","slug":"label-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Label type.\r\n\r\n\r\n\r\n\r\nOne of:\r\n\r\n- `\"SYSTEM\"`: The label is a predefined system label for the Contact List.\r\n- `\"USER_DEFINED\"`: The label was created by a site contributor or app.\r\n- `\"WIX_APP_DEFINED\"`: The label was created by a Wix app."},{"name":"namespace","slug":"namespace","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Label [namespace](wix-crm-backend/contacts/introduction#the-namespace-and-key-properties-in-labels-and-extended-fields).\r\n\r\n\r\nLabels created by site contributors or 3rd-party apps\r\nare automatically assigned to the `custom` namespace."}]},"Contacts.ContactsQueryBuilder.ContactsQueryBuilder":{"name":"ContactsQueryBuilder","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","slug":"contacts-query-builder","actions":[{"name":"and","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.and","slug":"and","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder"},"description":"A query to add to the initial query as an `and` condition."}],"description":"Adds an `and` condition to the query.\r\n\r\nThe `and()` function adds an `and` condition to a `ContactsQueryBuilder`.\r\nA query with an `and` returns all the items that match the query\r\nas defined up to the `and` function and also match the query or\r\nfilter passed to the `and` function.\r\n\r\nNote that when chaining multiple `ContactsQueryBuilder` functions to a query an `and` condition is assumed.\r\nIn such cases, you do not need to add a call to the `and()` function.\r\nFor example, this query returns results where subscription status is not set **and**\r\nthe contact was created after March 1, 2021.\r\n\r\n```javascript\r\ncontacts.queryContacts()\r\n.eq(\"info.extendedFields.emailSubscriptions.subscriptionStatus\", \"NOT_SET\")\r\n.gt(\"_createdDate\", \"2021-03-01T00:00:00.000Z\");\r\n```\r\n\r\nThe `and()` function is needed when performing compound queries. For\r\nexample, the final query in this set of queries returns results where subscription status\r\nis either not set or pending **and** creation date is earlier than than March 1, 2021 or\r\nthe contact is labeled as a stale lead.\r\n\r\n```javascript\r\nconst subscriptionStatusQuery = contacts.queryContacts()\r\n.eq(\"info.extendedFields.emailSubscriptions.subscriptionStatus\", \"NOT_SET\")\r\n.or(\r\n contacts.queryContacts()\r\n .eq(\"info.extendedFields.emailSubscriptions.subscriptionStatus\", \"PENDING\")\r\n);\r\n\r\nconst freshnessQuery = contacts.queryContacts()\r\n.lt(\"_updatedDate\", \"2021-03-01T00:00:00.000Z\")\r\n.or(\r\n contacts.queryContacts()\r\n .hasSome(\"info.labelKeys\", [\"custom.stale-lead\"])\r\n);\r\n\r\nconst statusAndFreshnessQuery = subscriptionStatusQuery.and(freshnessQuery);\r\n```\r\n\r\nThe `and()` function is designed to work with 2 or more queries or filters.\r\nIf you use it on its own, it will return all the items that meet the query criteria.","sdkErrors":[]},{"name":"ascending","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n\r\n- `_createdDate`\r\n- `lastActivity.activityDate`\r\n- `primaryInfo.email`\r\n- `info.name.first`\r\n- `info.name.last`\r\n- `info.company`\r\n- `info.jobTitle`\r\n- `info.birthdate`"}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `ContactsQueryBuilder` to sort in ascending order of\r\nthe specified properties. If you specify more than one property,\r\n`ascending()` sorts the results in ascending order by each property in the\r\norder they are listed.\r\n\r\nYou can sort the following types:\r\n\r\n+ Number: Sorts numerically.\r\n+ Date: Sorts by date and time.\r\n+ String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\nIf a property contains a number as a String, that value will be sorted\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified sort property are ranked lowest.","sdkErrors":[]},{"name":"between","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.between","slug":"between","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","rangeStart","rangeEnd"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared to `rangeStart` and `rangeEnd`.\r\n\r\nSupported properties:\r\n\r\n- `_createdDate`\r\n- `_updatedDate`\r\n- `lastActivity.activityDate`\r\n- `info.birthdate`"},{"name":"rangeStart","slug":"range-start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."},{"name":"rangeEnd","slug":"range-end","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is within a specified range.\r\n\r\nThe `between()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property is greater than or equal\r\nto `rangeStart` and less than `rangeEnd`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically, so\r\n+ `\"A\"` and `\"M\"` are between `\"A\"` and `\"Z\"`, but `\"a\"`, `\"m\"`, `\"z\"` and `\"Z\"` are not.\r\n+ `\"A\"`, `\"M\"`, `\"Z\"`, and `\"a\"` are between `\"A\"` and `\"z\"`, but `\"z\"` is not.","sdkErrors":[]},{"name":"descending","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n\r\n- `_createdDate`\r\n- `lastActivity.activityDate`\r\n- `primaryInfo.email`\r\n- `info.name.first`\r\n- `info.name.last`\r\n- `info.company`\r\n- `info.jobTitle`\r\n- `info.birthdate`"}],"description":"Adds a sort to a query, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `ContactsQueryBuilder` to sort in descending order of\r\nthe specified properties. If you specify more than one property,\r\n`descending()` sorts the results in descending order by each property in the\r\norder they are listed.\r\n\r\nYou can sort the following types:\r\n\r\n+ Number: Sorts numerically.\r\n+ Date: Sorts by date and time.\r\n+ String: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\r\n\r\nIf a property contains a number as a String, that value will be sorted\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified sort property are ranked lowest.","sdkErrors":[]},{"name":"eq","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\nSupported properties:\r\n\r\n- `\"_id\"`\r\n- `\"_createdDate\"`\r\n- `\"_updatedDate\"`\r\n- `\"lastActivity.activityDate\"`\r\n- `\"primaryInfo.email\"`\r\n- `\"primaryInfo.phone\"`\r\n- `\"info.name.first\"`\r\n- `\"info.name.last\"`\r\n- `\"info.emails.email\"`\r\n- `\"info.phones.phone\"`\r\n- `\"info.addresses.street\"`\r\n- `\"info.addresses.city\"`\r\n- `\"info.addresses.subdivision\"`\r\n- `\"info.addresses.country\"`\r\n- `\"info.company\"`\r\n- `\"info.jobTitle\"`\r\n- `\"info.birthdate\"`\r\n- `\"info.locale\"`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property equals the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nMatching strings with `eq()` is case sensitive in most instances, so `\"text\"` is not equal to `\"Text\"`. \r\nOne exception is email fields, which are case insensitive when matching with `eq()`.\r\n\r\nIf the value of the `propertyName` property is an Array, `eq()` includes items\r\nin which any of the elements of the Array match the specified `value`.","sdkErrors":[]},{"name":"find","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ContactsQueryResult","referenceFqn":"Contacts.ContactsQueryResult.ContactsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/contacts-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `ContactsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Returns the items that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\nby the query and some information about the results. The Promise is\r\nrejected if `find()` is called with incorrect permissions or if any of the\r\nfunctions used to refine the query are invalid.\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can query contacts.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"ge","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `\"_createdDate\"`\r\n- `\"_updatedDate\"`\r\n- `\"lastActivity.activityDate\"`\r\n- `\"info.birthdate\"`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than or equal to the specified value.\r\n\r\nThe `ge()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property is greater than or equal to the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically,\r\n`\"abc\"` is greater than or equal to `\"ABC\"` (because of the greater than),\r\nbut `\"ABC\"` is not greater than or equal to `\"abc\"`","sdkErrors":[]},{"name":"gt","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `\"_createdDate\"`\r\n- `\"_updatedDate\"`\r\n- `\"lastActivity.activityDate\"`\r\n- `\"info.birthdate\"`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than the specified value.\r\n\r\nThe `gt()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property is greater than the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`.","sdkErrors":[]},{"name":"hasAll","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.hasAll","slug":"has-all","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","values"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `info.labelKeys`"},{"name":"values","slug":"values","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The values to match against."}],"description":"Refines a query to match items whose specified property value contains all of the specified values.\r\n\r\nThe `hasAll()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the values of the array of the specified property equal all of\r\nthe specified values.\r\n\r\nMatching with `hasAll()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.","sdkErrors":[]},{"name":"hasSome","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","values"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `\"_id\"`\r\n- `\"primaryInfo.email\"`\r\n- `\"primaryInfo.phone\"`\r\n- `\"info.name.first\"`\r\n- `\"info.name.last\"`\r\n- `\"info.emails.email\"`\r\n- `\"info.phones.phone\"`\r\n- `\"info.addresses.street\"`\r\n- `\"info.addresses.city\"`\r\n- `\"info.addresses.subdivision\"`\r\n- `\"info.addresses.country\"`\r\n- `\"info.company\"`\r\n- `\"info.jobTitle\"`\r\n- `\"info.locale\"`\r\n- `\"info.labelKeys\"`"},{"name":"values","slug":"values","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The values to match against."}],"description":"Refines a query to match items whose specified property value contains any of the specified values.\r\n\r\nThe `hasSome()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where any of the values of the array of the specified property equal any of\r\nthe specified values.\r\n\r\nMatching with `hasSome()` is case-sensitive in most instances, so `\"text\"` is not equal to `\"Text\"`.\r\nOne exception is email fields, which are case insensitive when matching with `hasSome()`.","sdkErrors":[]},{"name":"le","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `\"_createdDate\"`\r\n- `\"_updatedDate\"`\r\n- `\"lastActivity.activityDate\"`\r\n- `\"info.birthdate\"`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than or equal to the specified value.\r\n\r\nThe `le()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property is less than or equal to the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically,\r\nso `\"ABC\"` is less than or equal to `\"abc\"` (because of the less than),\r\nbut `\"abc\"` is not less than or equal to `\"ABC\"`.","sdkErrors":[]},{"name":"limit","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Limit the number of items to return, which is also the [`pageSize`](wix-crm-backend/contacts/contacts-query-result/pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\npage. Only one page of results is retrieved at a time. The [`next()`](wix-crm-backend/contacts/contacts-query-result/next)\r\nand [`prev()`](wix-crm-backend/contacts/contacts-query-result/prev) functions are used to\r\nnavigate the pages of a query result.\r\n\r\nBy default, `limit` is set to `50`.\r\n\r\nThe maximum value that `limit()` can accept is `1000`.","sdkErrors":[]},{"name":"lt","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `\"_createdDate\"`\r\n- `\"_updatedDate\"`\r\n- `\"lastActivity.activityDate\"`\r\n- `\"info.birthdate\"`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than the specified value.\r\n\r\nThe `lt()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property is less than the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically, so `\"Text\"` is less than `\"text\"`.","sdkErrors":[]},{"name":"ne","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `\"_id\"`\r\n- `\"_createdDate\"`\r\n- `\"_updatedDate\"`\r\n- `\"lastActivity.activityDate\"`\r\n- `\"primaryInfo.email\"`\r\n- `\"primaryInfo.phone\"`\r\n- `\"info.name.first\"`\r\n- `\"info.name.last\"`\r\n- `\"info.emails.email\"`\r\n- `\"info.phones.phone\"`\r\n- `\"info.addresses.street\"`\r\n- `\"info.addresses.city\"`\r\n- `\"info.addresses.subdivision\"`\r\n- `\"info.addresses.country\"`\r\n- `\"info.company\"`\r\n- `\"info.jobTitle\"`\r\n- `\"info.birthdate\"`\r\n- `\"info.locale\"`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value does not equal the specified value.\r\n\r\nThe `ne()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property does not equal the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nMatching strings with `ne()` is case sensitive in most instances, so `\"text\"` is not equal to `\"Text\"`. \r\nOne exception is email fields, which are case insensitive when matching with `ne()`.\r\n\r\nIf the value of the `propertyName` property is an Array, `ne()` includes items\r\nin which none of the elements of the Array match the specified `value`.","sdkErrors":[]},{"name":"not","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.not","slug":"not","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder"},"description":"Contains functionality for refining a contacts query.\r\nThe `ContactsQueryBuilder` functions enable you to run, sort, filter, and control\r\nwhich results a query returns.\r\n\r\nTypically, you build a query using `queryContacts()` function,\r\nrefine the query by chaining `ContactsQueryBuilder` functions, and then execute the\r\nquery by chaining the [`find()`](#find) function."}],"description":"Adds an `not` condition to the query.\r\n\r\nThe `not()` function adds a `not` condition to a `ContactsQueryBuilder`. A query\r\nwith a `not` returns all the items that match the query as defined up to\r\nthe `not` function, but don't match the query passed to the `not` function.\r\n\r\nIf the query only contains a `not()` function, it returns all the items\r\nthat don't match the query defined by the `not` method.","sdkErrors":[]},{"name":"or","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.or","slug":"or","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder"},"description":"A query to add to the initial query as an `or` condition."}],"description":"Adds an `or` condition to the query.\r\n\r\nThe `or()` function adds an inclusive `or` condition to a `ContactsQueryBuilder`. A query\r\nwith an `or` returns all the items that match the query as defined up to\r\nthe `or` function, the items that match the query passed to the `or`\r\nfunction, and the items that match both.\r\n\r\nThe `or()` function is designed to work with 2 or more queries.\r\nIf you use it on its own, it will return all the items that meet the query criteria.","sdkErrors":[]},{"name":"skip","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\nresults before returning new query results.\r\n\r\nFor example, if you query your contacts and 50 items match your query, but\r\nyou set `skip` to 10, the results returned will skip the first 10 items\r\nthat match and return the 11th through 50th items.\r\n\r\nBy default, `skip` is set to 0.","sdkErrors":[]},{"name":"startsWith","fqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder.startsWith","slug":"starts-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `\"primaryInfo.email\"`\r\n- `\"primaryInfo.phone\"`\r\n- `\"info.name.first\"`\r\n- `\"info.name.last\"`\r\n- `\"info.emails.email\"`\r\n- `\"info.phones.phone\"`\r\n- `\"info.addresses.street\"`\r\n- `\"info.addresses.city\"`\r\n- `\"info.company\"`\r\n- `\"info.jobTitle\"`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value starts with a specified string.\r\n\r\nThe `startsWith()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property starts with a specified string.\r\nMatching with `startsWith()` is case-sensitive, so `\"TEXT\"` does not start with `\"tex\"`.\r\n\r\nYou can only use `startsWith()` with a property whose value is a String.","sdkErrors":[]}],"properties":[]},"Contacts.ContactsQueryResult.ContactsQueryResult":{"name":"ContactsQueryResult","fqn":"Contacts.ContactsQueryResult.ContactsQueryResult","slug":"contacts-query-result","actions":[{"name":"hasNext","fqn":"Contacts.ContactsQueryResult.ContactsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"description":"Indicates if the query has more results.","sdkErrors":[]},{"name":"hasPrev","fqn":"Contacts.ContactsQueryResult.ContactsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"description":"Indicates if the query has previous results.","sdkErrors":[]},{"name":"next","fqn":"Contacts.ContactsQueryResult.ContactsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ContactsQueryResult","referenceFqn":"Contacts.ContactsQueryResult.ContactsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/contacts-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `ContactsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/contacts-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions.\r\n\r\nIf items are added or removed between calls to `next()` the values returned\r\nby `ContactsQueryResult` may change.","sdkErrors":[]},{"name":"prev","fqn":"Contacts.ContactsQueryResult.ContactsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ContactsQueryResult","referenceFqn":"Contacts.ContactsQueryResult.ContactsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/contacts-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `ContactsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/contacts-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions.\r\n\r\nIf items are added or removed between calls to `prev()` the values returned\r\nby `ContactsQueryResult` may change.","sdkErrors":[]}],"properties":[{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Contact","referenceFqn":"Contacts.Contact"}},"description":"Returns the items that match the query.\r\n\r\nThe current page of items retrieved by the query.\r\n\r\nList of contacts.\r\n\r\n\r\n> **Note:** When no items match the query, the items array is empty.\r\n\r\nTo paginate your query results, use the `ContactsQueryResult` pagination properties and functions."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/contacts-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/contacts-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder"},"description":"Returns the `ContactsQueryBuilder` object used to get the current results.\r\n\r\nUse the `query` property to create and run a new query\r\nby chaining additional `ContactsQueryBuilder` functions to it."}]},"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder":{"name":"ExtendedFieldsQueryBuilder","fqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder","slug":"extended-fields-query-builder","actions":[{"name":"ascending","fqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryBuilder","referenceFqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder","description":"A `ExtendedFieldsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n\r\n- `_createdDate`\r\n- `_updatedDate`\r\n- `displayName`"}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `ExtendedFieldsQueryBuilder` to sort in ascending order of\r\nthe specified properties. If you specify more than one property,\r\n`ascending()` sorts the results in ascending order by each property in the\r\norder they are listed.\r\n\r\nYou can sort the following types:\r\n\r\n+ Number: Sorts numerically.\r\n+ Date: Sorts by date and time.\r\n+ String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\nIf a property contains a number as a String, that value will be sorted\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified sort property are ranked lowest.","sdkErrors":[]},{"name":"descending","fqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryBuilder","referenceFqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder","description":"A `ExtendedFieldsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n\r\n- `_createdDate`\r\n- `_updatedDate`\r\n- `displayName`"}],"description":"Adds a sort to a query, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `ExtendedFieldsQueryBuilder` to sort in ascending order of\r\nthe specified properties. If you specify more than one property,\r\n`descending()` sorts the results in descending order by each property in the\r\norder they are listed.\r\n\r\nYou can sort the following types:\r\n\r\n+ Number: Sorts numerically.\r\n+ Date: Sorts by date and time.\r\n+ String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\nIf a property contains a number as a String, that value will be sorted\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified sort property are ranked lowest.","sdkErrors":[]},{"name":"find","fqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryResult","referenceFqn":"Contacts.ExtendedFieldsQueryResult.ExtendedFieldsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/extended-fields-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `ExtendedFieldsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Returns the items that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\nby the query and some information about the results. The Promise is\r\nrejected if `find()` is called with incorrect permissions or if any of the\r\nfunctions used to refine the query are invalid.\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can query extended fields.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"limit","fqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryBuilder","referenceFqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder","description":"A `ExtendedFieldsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Limit the number of items to return, which is also the [`pageSize`](wix-crm-backend/contacts/extended-fields-query-result/pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\npage. Only one page of results is retrieved at a time. The [`next()`](wix-crm-backend/contacts/extended-fields-query-result/next)\r\nand [`prev()`](wix-crm-backend/contacts/extended-fields-query-result/prev) functions are used to\r\nnavigate the pages of a query result.\r\n\r\nBy default, `limit` is set to `50`.\r\n\r\nThe maximum value that `limit()` can accept is `1000`.","sdkErrors":[]},{"name":"skip","fqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryBuilder","referenceFqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder","description":"A `ExtendedFieldsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\nresults before returning new query results.\r\n\r\nFor example, if you query your contacts and 50 items match your query, but\r\nyou set `skip` to 10, the results returned will skip the first 10 items\r\nthat match and return the 11th through 50th items.\r\n\r\nBy default, `skip` is set to 0.","sdkErrors":[]}],"properties":[]},"Contacts.ExtendedFieldsQueryResult.ExtendedFieldsQueryResult":{"name":"ExtendedFieldsQueryResult","fqn":"Contacts.ExtendedFieldsQueryResult.ExtendedFieldsQueryResult","slug":"extended-fields-query-result","actions":[{"name":"hasNext","fqn":"Contacts.ExtendedFieldsQueryResult.ExtendedFieldsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"description":"Indicates if the query has more results.","sdkErrors":[]},{"name":"hasPrev","fqn":"Contacts.ExtendedFieldsQueryResult.ExtendedFieldsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"description":"Indicates if the query has previous results.","sdkErrors":[]},{"name":"next","fqn":"Contacts.ExtendedFieldsQueryResult.ExtendedFieldsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryResult","referenceFqn":"Contacts.ExtendedFieldsQueryResult.ExtendedFieldsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/extended-fields-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `ExtendedFieldsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/extended-fields-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions.\r\n\r\nIf items are added or removed between calls to `next()` the values returned\r\nby `ExtendedFieldsQueryResult` may change.","sdkErrors":[]},{"name":"prev","fqn":"Contacts.ExtendedFieldsQueryResult.ExtendedFieldsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryResult","referenceFqn":"Contacts.ExtendedFieldsQueryResult.ExtendedFieldsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/extended-fields-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `ExtendedFieldsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/extended-fields-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions.\r\n\r\nIf items are added or removed between calls to `prev()` the values returned\r\nby `ExtendedFieldsQueryResult` may change.","sdkErrors":[]}],"properties":[{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ExtendedField","referenceFqn":"Contacts.ExtendedField"}},"description":"Returns the items that match the query.\r\n\r\nThe current page of items retrieved by the query.\r\n\r\nList of extended fields.\r\n\r\n> **Note:** When no items match the query, the items array is empty.\r\n\r\nTo paginate your query results, use the `ExtendedFieldsQueryResult` pagination properties and functions."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/extended-fields-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/extended-fields-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExtendedFieldsQueryBuilder","referenceFqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder"},"description":"Returns the `ExtendedFieldsQueryBuilder` object used to get the current results.\r\n\r\nUse the `query` property to create and run a new query\r\nby chaining additional `ExtendedFieldsQueryBuilder` functions to it.\r\nYou can filter only on properties that have not not already been used in the previous query."}]},"Contacts.LabelsQueryBuilder.LabelsQueryBuilder":{"name":"LabelsQueryBuilder","fqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder","slug":"labels-query-builder","actions":[{"name":"ascending","fqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LabelsQueryBuilder","referenceFqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder","description":"A `LabelsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n\r\n- `_createdDate`\r\n- `_updatedDate`\r\n- `displayName`"}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `LabelsQueryBuilder` to sort in ascending order of\r\nthe specified properties. If you specify more than one property,\r\n`ascending()` sorts the results in ascending order by each property in the\r\norder they are listed.\r\n\r\nYou can sort the following types:\r\n\r\n+ Number: Sorts numerically.\r\n+ Date: Sorts by date and time.\r\n+ String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\nIf a property contains a number as a String, that value will be sorted\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified sort property are ranked lowest.","sdkErrors":[]},{"name":"descending","fqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LabelsQueryBuilder","referenceFqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder","description":"A `LabelsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n\r\n- `_createdDate`\r\n- `_updatedDate`\r\n- `displayName`"}],"description":"Adds a sort to a query, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `LabelsQueryBuilder` to sort in ascending order of\r\nthe specified properties. If you specify more than one property,\r\n`descending()` sorts the results in descending order by each property in the\r\norder they are listed.\r\n\r\nYou can sort the following types:\r\n\r\n+ Number: Sorts numerically.\r\n+ Date: Sorts by date and time.\r\n+ String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\nIf a property contains a number as a String, that value will be sorted\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified sort property are ranked lowest.","sdkErrors":[]},{"name":"find","fqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"LabelsQueryResult","referenceFqn":"Contacts.LabelsQueryResult.LabelsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/labels-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `LabelsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Returns the items that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\nby the query and some information about the results. The Promise is\r\nrejected if `find()` is called with incorrect permissions or if any of the\r\nfunctions used to refine the query are invalid.\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can query labels.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"limit","fqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LabelsQueryBuilder","referenceFqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder","description":"A `LabelsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Limit the number of items to return, which is also the [`pageSize`](wix-crm-backend/contacts/labels-query-result/pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\npage. Only one page of results is retrieved at a time. The [`next()`](wix-crm-backend/contacts/labels-query-result/next)\r\nand [`prev()`](wix-crm-backend/contacts/labels-query-result/prev) functions are used to\r\nnavigate the pages of a query result.\r\n\r\nBy default, `limit` is set to `50`.\r\n\r\nThe maximum value that `limit()` can accept is `1000`.","sdkErrors":[]},{"name":"skip","fqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LabelsQueryBuilder","referenceFqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder","description":"A `LabelsQueryBuilder` object that contains the refined query."},"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\nresults before returning new query results.\r\n\r\nFor example, if you query your contacts and 50 items match your query, but\r\nyou set `skip` to 10, the results returned will skip the first 10 items\r\nthat match and return the 11th through 50th items.\r\n\r\nBy default, `skip` is set to 0.","sdkErrors":[]}],"properties":[]},"Contacts.LabelsQueryResult.LabelsQueryResult":{"name":"LabelsQueryResult","fqn":"Contacts.LabelsQueryResult.LabelsQueryResult","slug":"labels-query-result","actions":[{"name":"hasNext","fqn":"Contacts.LabelsQueryResult.LabelsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"description":"Indicates if the query has more results.","sdkErrors":[]},{"name":"hasPrev","fqn":"Contacts.LabelsQueryResult.LabelsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"description":"Indicates if the query has previous results.","sdkErrors":[]},{"name":"next","fqn":"Contacts.LabelsQueryResult.LabelsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"LabelsQueryResult","referenceFqn":"Contacts.LabelsQueryResult.LabelsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/labels-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `LabelsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/labels-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions.\r\n\r\nIf items are added or removed between calls to `next()` the values returned\r\nby `LabelsQueryResult` may change.","sdkErrors":[]},{"name":"prev","fqn":"Contacts.LabelsQueryResult.LabelsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"LabelsQueryResult","referenceFqn":"Contacts.LabelsQueryResult.LabelsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/labels-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `LabelsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/labels-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions.\r\n\r\nIf items are added or removed between calls to `prev()` the values returned\r\nby `LabelsQueryResult` may change.","sdkErrors":[]}],"properties":[{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Label","referenceFqn":"Contacts.Label"}},"description":"Returns the items that match the query.\r\n\r\nThe current page of items retrieved by the query.\r\n\r\nList of labels.\r\n\r\n> **Note:** When no items match the query, the items array is empty.\r\n\r\nTo paginate your query results, use the `LabelsQueryResult` pagination properties and functions."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/labels-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/labels-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LabelsQueryBuilder","referenceFqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder"},"description":"Returns the `LabelsQueryBuilder` object used to get the current results.\r\n\r\nUse the `query` property to create and run a new query\r\nby chaining additional `LabelsQueryBuilder` functions to it."}]},"Contacts.Identifiers":{"name":"Identifiers","fqn":"Contacts.Identifiers","slug":"identifiers","actions":[],"properties":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the contact to update."},{"name":"revision","slug":"revision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Revision number.\r\n When updating, include the existing `revision`\r\n to prevent conflicting updates."}]},"Events.CardCreatedEvent":{"name":"CardCreatedEvent","fqn":"Events.CardCreatedEvent","slug":"card-created-event","actions":[],"properties":[{"name":"card","slug":"card","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Card","referenceFqn":"Workflows.Card"},"description":"The card that was created."},{"name":"phaseId","slug":"phase-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the card's phase."},{"name":"phaseName","slug":"phase-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the card's phase."},{"name":"workflowId","slug":"workflow-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the card's workflow."},{"name":"workflowName","slug":"workflow-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the card's workflow."}]},"Workflows.Card":{"name":"Card","fqn":"Workflows.Card","slug":"card","actions":[],"properties":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the contact associated with the card."},{"name":"createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date the card was created."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique card identifier."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the card."},{"name":"phaseId","slug":"phase-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the phase which contains the card."},{"name":"source","slug":"source","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Source that created the card.\r\n\r\n Some possible values:\r\n\r\n + `\"Contacts\"`\r\n + `\"Velo\"`\r\n + `\"Inbox\"`\r\n + `\"Invoices\"`\r\n + `\"Marketplace\"`\r\n + `\"Price Quotes\"`\r\n + `\"Wix Forms\"`"},{"name":"updatedDate","slug":"updated-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date the card was last updated."}]},"Events.CardMovedEvent":{"name":"CardMovedEvent","fqn":"Events.CardMovedEvent","slug":"card-moved-event","actions":[],"properties":[{"name":"card","slug":"card","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Card","referenceFqn":"Workflows.Card"},"description":"The card that was moved."},{"name":"newPhaseId","slug":"new-phase-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the card's new phase."},{"name":"newPhaseName","slug":"new-phase-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the card's new phase."},{"name":"previousPhaseId","slug":"previous-phase-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the card's old phase."},{"name":"previousPhaseName","slug":"previous-phase-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the card's old phase."},{"name":"workflowId","slug":"workflow-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the card's workflow."},{"name":"workflowName","slug":"workflow-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the card's workflow."}]},"Events.CardRestoredEvent":{"name":"CardRestoredEvent","fqn":"Events.CardRestoredEvent","slug":"card-restored-event","actions":[],"properties":[{"name":"card","slug":"card","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Card","referenceFqn":"Workflows.Card"},"description":"The card that was restored."},{"name":"phaseId","slug":"phase-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the phase the card was restored to."},{"name":"phaseName","slug":"phase-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the phase the card was restored to."},{"name":"workflowId","slug":"workflow-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the workflow the card was restored to."},{"name":"workflowName","slug":"workflow-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the workflow the card was restored to."}]},"Events.ContactCreatedEvent":{"name":"ContactCreatedEvent","fqn":"Events.ContactCreatedEvent","slug":"contact-created-event","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Contact","referenceFqn":"Contacts.Contact"},"description":"Created contact."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"Events.EventMetadata"},"description":"Event metadata."}]},"Events.EventMetadata":{"name":"EventMetadata","fqn":"Events.EventMetadata","slug":"event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application\r\n(for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)).\r\nFor advanced users."}]},"Events.ContactDeletedEvent":{"name":"ContactDeletedEvent","fqn":"Events.ContactDeletedEvent","slug":"contact-deleted-event","actions":[],"properties":[{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateAndDeleteMetadata","referenceFqn":"Events.UpdateAndDeleteMetadata"},"description":"Event metadata."}]},"Events.UpdateAndDeleteMetadata":{"name":"UpdateAndDeleteMetadata","fqn":"Events.UpdateAndDeleteMetadata","slug":"update-and-delete-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"originatedFrom","slug":"originated-from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"If present and set to `\"merge\"`,\r\nindicates the event was triggered by a merge.\r\n\r\nSee [`onContactMerged()`](#onContactMerged) for information on handling\r\nmerge events."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application\r\n(for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)).\r\nFor advanced users."}]},"Events.ContactMergedEvent":{"name":"ContactMergedEvent","fqn":"Events.ContactMergedEvent","slug":"contact-merged-event","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactMergedData","referenceFqn":"Events.ContactMergedData"},"description":"Information about the source and target contacts."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EventMetadata","referenceFqn":"Events.EventMetadata"},"description":"Event metadata."}]},"Events.ContactMergedData":{"name":"ContactMergedData","fqn":"Events.ContactMergedData","slug":"contact-merged-data","actions":[],"properties":[{"name":"sourceContactIds","slug":"source-contact-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of the source contacts."},{"name":"targetContact","slug":"target-contact","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Contact","referenceFqn":"Contacts.Contact"},"description":"Updated target contact."},{"name":"targetContactId","slug":"target-contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the target contact."}]},"Events.ContactUpdatedEvent":{"name":"ContactUpdatedEvent","fqn":"Events.ContactUpdatedEvent","slug":"contact-updated-event","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Contact","referenceFqn":"Contacts.Contact"},"description":"Updated contact."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateAndDeleteMetadata","referenceFqn":"Events.UpdateAndDeleteMetadata"},"description":"Event metadata."}]},"Events.FormSubmitEvent":{"name":"FormSubmitEvent","fqn":"Events.FormSubmitEvent","slug":"form-submit-event","actions":[],"properties":[{"name":"attachments","slug":"attachments","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FormAttachment","referenceFqn":"Events.FormAttachment"}},"description":"The Wix Form's attachments."},{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID of the site visitor submitting the Wix Form."},{"name":"formName","slug":"form-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the Wix Form."},{"name":"submissionData","slug":"submission-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FormField","referenceFqn":"Events.FormField"}},"description":"Data submitted in the Wix Form. The object contains key:value pairs where the key is the field name and the value is the contents of the field."},{"name":"submissionTime","slug":"submission-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time that the Wix Form was submitted."}]},"Events.FormAttachment":{"name":"FormAttachment","fqn":"Events.FormAttachment","slug":"form-attachment","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the attachment."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Type of attachment.\r\nOne of:\r\n\r\n+ `\"UNDEFINED\"`\r\n+ `\"DOCUMENT\"`\r\n+ `\"IMAGE\"`\r\n+ `\"VIDEO\"`"},{"name":"url","slug":"url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"URL of the attachment."}]},"Events.FormField":{"name":"FormField","fqn":"Events.FormField","slug":"form-field","actions":[],"properties":[{"name":"fieldName","slug":"field-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the field."},{"name":"fieldValue","slug":"field-value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Value of the field."}]},"Notifications.NotificationOptions":{"name":"NotificationOptions","fqn":"Notifications.NotificationOptions","slug":"notification-options","actions":[],"properties":[{"name":"actionTarget","slug":"action-target","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ActionTarget","referenceFqn":"Notifications.ActionTarget"},"description":"Where to navigate to when the `actionTitle` text is clicked."},{"name":"actionTitle","slug":"action-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Call to action text to be clicked on. When clicked, navigates to the `actionTarget` URL. Max length: 512 characters."},{"name":"recipients","slug":"recipients","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SiteContributors","referenceFqn":"Notifications.SiteContributors"},"description":"Contributor that will receive the notifications, based on their assigned roles.\r\n One of:\r\n\r\n + `\"All_Contributors\"`: All site contributors, including the site owner.\r\n + `\"Owner\"`: Only the site owner."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Notification title. Only displayed on mobile and browser notifications. Max length: 512 characters."}]},"Notifications.ActionTarget":{"name":"ActionTarget","fqn":"Notifications.ActionTarget","slug":"action-target","actions":[],"properties":[{"name":"url","slug":"url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"URL to navigate to when the `actionTitle` text is clicked."}]},"Notifications.SiteContributors":{"name":"SiteContributors","fqn":"Notifications.SiteContributors","slug":"site-contributors","actions":[],"properties":[{"name":"role","slug":"role","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Roles to receive the notification.\r\nOne of:\r\n\r\n+ `\"All_Contributors\"`: All site contributors (default).\r\n+ `\"Owner\"`: Only the site owner."}]},"Tasks.TaskInfo":{"name":"TaskInfo","fqn":"Tasks.TaskInfo","slug":"task-info","actions":[],"properties":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique identifier of the site contact\r\n that this task is linked to."},{"name":"dueDate","slug":"due-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date the task is due."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Task title."}]},"Tasks.Task":{"name":"Task","fqn":"Tasks.Task","slug":"task","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique task identifier."},{"name":"applicationId","slug":"application-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"When `creatorType` is `\"APP\"`, the unique\r\n identifier of the application that created the task. Otherwise, `applicationId` is not\r\n present."},{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique identifier of the site contact\r\n that this task is linked to."},{"name":"creatorType","slug":"creator-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Type of the task's creator. `\"USER\"`\r\n if the task was created using the site's dashboard. `\"APP\"` if the task was\r\n created using the [`createTask()`](#createTask) function or if it was created\r\n by an app installed on the site."},{"name":"dueDate","slug":"due-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date the task is due."},{"name":"isCompleted","slug":"is-completed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates whether the task has been\r\n completed."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Task title."},{"name":"userId","slug":"user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"When `creatorType` is `\"USER\"`, the unique\r\n identifier of the user that created the task in the dashboard. Otherwise, `userId` is not\r\n present."},{"name":"version","slug":"version","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Running task version number. Each time an\r\n action is performed on a task its version number is incremented."}]},"Workflows.CreateCardRequest":{"name":"CreateCardRequest","fqn":"Workflows.CreateCardRequest","slug":"create-card-request","actions":[],"properties":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the contact associated with the card."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the card."}]},"Workflows.CreatePhaseRequest":{"name":"CreatePhaseRequest","fqn":"Workflows.CreatePhaseRequest","slug":"create-phase-request","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the phase."}]},"Workflows.CreateWorkflowRequest":{"name":"CreateWorkflowRequest","fqn":"Workflows.CreateWorkflowRequest","slug":"create-workflow-request","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Workflow description."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the workflow."}]},"Workflows.Phase":{"name":"Phase","fqn":"Workflows.Phase","slug":"phase","actions":[],"properties":[{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique phase identifier."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the phase."}]},"Workflows.Workflow":{"name":"Workflow","fqn":"Workflows.Workflow","slug":"workflow","actions":[],"properties":[{"name":"winPhaseId","slug":"win-phase-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the win phase."},{"name":"workflowInfo","slug":"workflow-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WorkflowInfo","referenceFqn":"Workflows.WorkflowInfo"},"description":"Workflow information."}]},"Workflows.WorkflowInfo":{"name":"WorkflowInfo","fqn":"Workflows.WorkflowInfo","slug":"workflow-info","actions":[],"properties":[{"name":"createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date the workflow was created."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Workflow description."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique workflow identifier."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the workflow."}]},"Workflows.ListCardOptions":{"name":"ListCardOptions","fqn":"Workflows.ListCardOptions","slug":"list-card-options","actions":[],"properties":[{"name":"fetchOnlyArchived","slug":"fetch-only-archived","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to retrieve only archived cards. Not to be used with `phaseId`."},{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum number of cards to retrieve. Defaults to `50`."},{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderOptions","referenceFqn":"Workflows.OrderOptions"},"description":"Ordering options."},{"name":"phaseId","slug":"phase-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of phase to retrieve cards from. If omitted, will retrieve cards from all phases. Not to be used with `fetchOnlyArchived`."},{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of cards to skip before the retrieved items. Defaults to `0`."}]},"Workflows.OrderOptions":{"name":"OrderOptions","fqn":"Workflows.OrderOptions","slug":"order-options","actions":[],"properties":[{"name":"field","slug":"field","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Field to sort on."},{"name":"sort","slug":"sort","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order of sort. Either `\"asc\"` or `\"desc\"` (defaults to `\"asc\"`)."}]},"Workflows.CardList":{"name":"CardList","fqn":"Workflows.CardList","slug":"card-list","actions":[],"properties":[{"name":"currentPage","slug":"current-page","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Index of the current page. Indices are zero-based."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Card","referenceFqn":"Workflows.Card"}},"description":"List of cards matching the list options."},{"name":"length","slug":"length","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items in the current results page."},{"name":"pageSize","slug":"page-size","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items returned per page with the current list options."},{"name":"totalCount","slug":"total-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of cards in the specified workflow and phase."},{"name":"totalPages","slug":"total-pages","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of results pages."}]},"Workflows.ListOptions":{"name":"ListOptions","fqn":"Workflows.ListOptions","slug":"list-options","actions":[],"properties":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum number of items to retrieve. Defaults to `50` for phases and `100` for workflows."},{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderOptions","referenceFqn":"Workflows.OrderOptions"},"description":"Ordering options."},{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to skip before the retrieved items. Defaults to `0`."}]},"Workflows.PhaseList":{"name":"PhaseList","fqn":"Workflows.PhaseList","slug":"phase-list","actions":[],"properties":[{"name":"currentPage","slug":"current-page","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Index of the current page. Indices are zero-based."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Phase","referenceFqn":"Workflows.Phase"}},"description":"List of phases matching the list options."},{"name":"length","slug":"length","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items in the current results page."},{"name":"pageSize","slug":"page-size","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items returned per page with the current list options."},{"name":"totalCount","slug":"total-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of phases in the specified workflow."},{"name":"totalPages","slug":"total-pages","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of results pages."}]},"Workflows.WorkflowList":{"name":"WorkflowList","fqn":"Workflows.WorkflowList","slug":"workflow-list","actions":[],"properties":[{"name":"currentPage","slug":"current-page","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Index of the current page. Indices are zero-based."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"WorkflowInfo","referenceFqn":"Workflows.WorkflowInfo"}},"description":"List of workflows matching the list options."},{"name":"length","slug":"length","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items in the current results page."},{"name":"pageSize","slug":"page-size","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items returned per page with the current list options."},{"name":"totalCount","slug":"total-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of workflows in the site."},{"name":"totalPages","slug":"total-pages","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Total number of results pages."}]},"Workflows.MoveCardOptions":{"name":"MoveCardOptions","fqn":"Workflows.MoveCardOptions","slug":"move-card-options","actions":[],"properties":[{"name":"newPhaseId","slug":"new-phase-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the phase to move the card to. If omitted, the card remains in the same phase."},{"name":"newPosition","slug":"new-position","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Position within the phase to move the card to. If omitted, the card is moved to the top of the phase."}]},"Workflows.MovePhaseOptions":{"name":"MovePhaseOptions","fqn":"Workflows.MovePhaseOptions","slug":"move-phase-options","actions":[],"properties":[{"name":"newPosition","slug":"new-position","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Position within the workflow to move the phase to."},{"name":"workflowId","slug":"workflow-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the workflow to move the phase to."}]},"Workflows.UpdateCardRequest":{"name":"UpdateCardRequest","fqn":"Workflows.UpdateCardRequest","slug":"update-card-request","actions":[],"properties":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the contact associated with the card."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the card."},{"name":"phaseId","slug":"phase-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the phase which contains the card."},{"name":"source","slug":"source","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Source that created the card.\r\n\r\n Some possible values:\r\n\r\n + `\"Contacts\"`\r\n + `\"Velo\"`\r\n + `\"Inbox\"`\r\n + `\"Invoices\"`\r\n + `\"Marketplace\"`\r\n + `\"Price Quotes\"`\r\n + `\"Wix Forms\"`"}]},"Workflows.UpdatePhaseRequest":{"name":"UpdatePhaseRequest","fqn":"Workflows.UpdatePhaseRequest","slug":"update-phase-request","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the phase."}]},"Workflows.UpdateWorkflowRequest":{"name":"UpdateWorkflowRequest","fqn":"Workflows.UpdateWorkflowRequest","slug":"update-workflow-request","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Workflow description."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the workflow."}]}},"standaloneTypes":[],"metadata":{},"actions":[{"name":"createContact","fqn":"createContact","slug":"create-contact","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["contactInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfilled - The ID of the new or updated contact.\r\nRejected - Error message."},"examples":[{"title":"Create a new contact","description":"This example uses a deprecated function.\n\n This example contains a backend function that creates a new contact and\n returns the new contact's ID to the code that called the function.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport wixCrmBackend from 'wix-crm-backend';\n\nexport const myBackendFunction = webMethod(Permissions.Anyone, async (firstName, lastName, email, phone) => {\n return wixCrmBackend.createContact({\n \"firstName\": firstName,\n \"lastName\": lastName,\n \"emails\": [email],\n \"phones\": [phone]\n })\n .then((result) => {\n const contactId = result;\n return contactId;\n });\n});"}],"actionParams":[{"name":"contactInfo","slug":"contact-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactInfo","referenceFqn":"ContactInfo"},"description":"The information for the contact being created or updated."}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is available at\r\n[wix-crm-backend.contacts.createContact()](/contacts/create-contact).\r\n\r\nCreates a new contact or updates an existing contact.\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-crm-backend.contacts.createContact()`](/contacts/create-contact).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { contacts } from 'wix-crm-backend'\r\n> ```\r\n>\r\n> 2. If you plan to migrate all contact functions that use `wixCrmBackend`,\r\n> remove the original `import wixCrmBackend` statement.\r\n>\r\n> 3. Look for any code that uses `wixCrmBackend.createContact()`,\r\n> and replace it with `contacts.createContact()`.\r\n> Update your code to work with the new `createContact()`\r\n> call and response properties.\r\n>\r\n> 4. Test your changes to make sure your code behaves as expected.\r\n\r\n The `createContact()` function returns a Promise that resolves to the newly\r\n created or updated contact's ID when the contact has been created or updated.\r\n\r\n The passed `ContactInfo` object must contain at least one\r\n email address or phone number.","sdkErrors":[]},{"name":"deleteContact","fqn":"deleteContact","slug":"delete-contact","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["contactId","options"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the contact is deleted.\r\nRejected - Error message."},"examples":[{"title":"Delete a contact","description":"This example uses a deprecated function.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport wixCrmBackend from 'wix-crm-backend';\n\nexport const deleteContact = webMethod(Permissions.Anyone, (contactId) => {\n wixCrmBackend.deleteContact(contactId)\n .then( () => {\n // contact has been deleted\n })\n .catch( (err) => {\n // there was an error deleting the contact\n });\n});"},{"title":"Force the deletion of a contact","description":"This example uses a deprecated function.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport wixCrmBackend from 'wix-crm-backend';\n\nexport const deleteContactForcefully = webMethod(Permissions.Anyone, (contactId) => {\n const options = {\n \"deleteMembers\": true\n };\n \n return wixCrmBackend.deleteContact(contactId, options)\n .then( () => {\n // contact has been deleted\n })\n .catch( (err) => {\n // there was an error deleting the contact\n });\n});"}],"actionParams":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the contact to delete."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeleteOptions","referenceFqn":"DeleteOptions"},"description":"Options to use when deleting the contact."}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is available at\r\n[wix-crm-backend.contacts.deleteContact()](wix-crm-backend/contacts/delete-contact).\r\n\r\nDeletes an existing contact.\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-crm-backend.contacts.deleteContact()`](wix-crm-backend/contacts/delete-contact).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { contacts } from 'wix-crm-backend'\r\n> ```\r\n>\r\n> 2. If you plan to migrate all contact functions that use `wixCrmBackend`,\r\n> remove the original `import wixCrmBackend` statement.\r\n>\r\n> 3. Look for any code that uses `wixCrmBackend.deleteContact()`,\r\n> and replace it with `contacts.deleteContact()`.\r\n> Update your code to work with the new `deleteContact()`\r\n> call and response properties.\r\n>\r\n> 4. Test your changes to make sure your code behaves as expected.\r\n\r\n The `deleteContact()` function returns a Promise that resolves when the\r\n contact with the given ID is deleted.","sdkErrors":[]},{"name":"emailContact","fqn":"emailContact","slug":"email-contact","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["emailId","toContact"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the email is sent.\r\nRejected - Error message."},"examples":[{"title":"Send a Triggered Email","description":"This example uses a deprecated function.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport wixCrmBackend from 'wix-crm-backend';\n\nexport const myBackendFunction = webMethod(Permissions.Anyone, () => {\n let contactId = // get contact ID\n\n wixCrmBackend.emailContact(\"emailID\", contactId)\n .then( () => {\n // email has been sent\n } )\n .catch( (err) => {\n // there was an error sending the email\n } );\n});"}],"actionParams":[{"name":"emailId","slug":"email-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The Email ID of the Triggered Email to send."},{"name":"toContact","slug":"to-contact","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The contact's ID you are sending the email to."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TriggeredEmailOptions","referenceFqn":"TriggeredEmails.TriggeredEmailOptions"},"description":"Variable values to insert into the email."}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is available at\r\n[wix-crm-backend.triggeredEmails.emailContact()](https://www.wix.com/velo/reference/wix-crm-backend/triggeredemails/emailcontact).\r\n\r\nSends a Triggered Email to a contact.\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-crm-backend.triggeredEmails.emailContact()`](wix-crm-backend/triggered-emails/email-contact).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { triggeredEmails } from 'wix-crm-backend'\r\n> ```\r\n>\r\n> 2. If you plan to migrate all functions that use `wixCrmBackend`,\r\n> remove the original `import wixCrmBackend` statement.\r\n>\r\n> 3. Look for any code that uses `wixCrmBackend.emailContact()`,\r\n> and replace it with `triggeredEmails.emailContact()`.\r\n> Update your code to work with the new `emailContact()`\r\n> call and response properties.\r\n>\r\n> 4. Test your changes to make sure your code behaves as expected.\r\n\r\n To learn more about Triggered Emails, see:\r\n\r\n + [About Triggered Emails](https://support.wix.com/en/article/about-triggered-emails)\r\n + [Creating a Triggered Email](https://support.wix.com/en/article/creating-a-triggered-email)\r\n + [How to Send a Triggered Email to Contacts with Code](https://support.wix.com/en/article/how-to-send-a-triggered-email-to-contacts-with-code)\r\n\r\n\r\n Before using the `emailContact()` function, you need to set up at least one\r\n Triggered Email.\r\n\r\n Specify which email to send by passing the email's ID in the `emailId` parameter.\r\n\r\n Specify which contact the email is sent to by passing a contact's ID in the `toContact`\r\n parameter.\r\n\r\n If the specified Triggered Email contains variables,\r\n you can pass values for those variables using the optional `options` parameter.\r\n You pass a `TriggeredEmailOptions` object\r\n which contains the values to be inserted into your email in place of the variables\r\n defined in that email. The values passed must be strings. If the object you\r\n pass to the `options` parameter does not contain a `key:value` pair for a\r\n variable in your Triggered Email, the fallback value defined when creating\r\n your Triggered Email is inserted in place of the variable.\r\n\r\n Note that Triggered Emails generates a code snippet for each of your email\r\n templates. The generated code includes the email's ID and keys for all the\r\n email's variable names. You can copy and paste the snippet into your code.\r\n Then, you need to define values for the `toContact` property and for each\r\n variable key. To learn how to use the generated snippet in your code, see\r\n [How to Send a Triggered Email with Code](https://support.wix.com/en/article/how-to-send-a-triggered-email-with-code).","sdkErrors":[]},{"name":"getContactById","fqn":"getContactById","slug":"get-contact-by-id","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["contactId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ContactInfo","referenceFqn":"ContactInfo"},"description":"Fulfilled - The given contact's information.\r\nRejected - Error message."},"examples":[{"title":"Get a contact by ID","description":"This example uses a deprecated function.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport wixCrmBackend from 'wix-crm-backend';\n\nexport const myBackendFunction = webMethod(Permissions.Anyone, (contactId) => {\n return wixCrmBackend.getContactById(contactId);\n});"}],"actionParams":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the contact to get."}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is available at\r\n[wix-crm-backend.contacts.getContact()](wix-crm-backend/contacts/get-contact).\r\n\r\nGets an existing contact by ID.\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-crm-backend.contacts.getContact()`](wix-crm-backend/contacts/get-contact).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { contacts } from 'wix-crm-backend'\r\n> ```\r\n>\r\n> 2. If you plan to migrate all contact functions that use `wixCrmBackend`,\r\n> remove the original `import wixCrmBackend` statement.\r\n>\r\n> 3. Look for any code that uses `wixCrmBackend.getContactById()`,\r\n> and replace it with `contacts.getContact()`.\r\n> Update your code to work with the new `getContact()`\r\n> call and response properties.\r\n>\r\n> 4. Test your changes to make sure your code behaves as expected.\r\n\r\n The `getContactById()` function returns a Promise that resolves to a contact\r\n whose ID matches the given ID.","sdkErrors":[]},{"name":"updateContact","fqn":"updateContact","slug":"update-contact","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["contactId","contactInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the contact is updated.\r\nRejected - Error message."},"examples":[{"title":"Update an existing contact","description":"This example uses a deprecated function.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport wixCrmBackend from 'wix-crm-backend';\n\nexport const myBackendFunction = webMethod(Permissions.Anyone, (contactId, firstName, lastName, email, phone) => {\n wixCrmBackend.updateContact(contactId, {\n \"firstName\": firstName,\n \"lastName\": lastName,\n \"emails\": [email],\n \"phones\": [phone]\n } )\n .then( () => {\n // contact has been updated\n } )\n .catch( (err) => {\n // there was an error updating the contact\n } );\n});"}],"actionParams":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the contact to update."},{"name":"contactInfo","slug":"contact-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactInfo","referenceFqn":"ContactInfo"},"description":"The information to update."}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is available at\r\n[wix-crm-backend.contacts.updateContact()](wix-crm-backend/contacts/update-contact).\r\n\r\nUpdates an existing contact.\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-crm-backend.contacts.updatecontact()`](wix-crm-backend/contacts/update-contact).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { contacts } from 'wix-crm-backend'\r\n> ```\r\n>\r\n> 2. If you plan to migrate all contact functions that use `wixCrmBackend`,\r\n> remove the original `import wixCrmBackend` statement.\r\n>\r\n> 3. Look for any code that uses `wixCrmBackend.updateContact()`,\r\n> and replace it with `contacts.updateContact()`.\r\n> Update your code to work with the new `updateContact()`\r\n> call and response properties.\r\n>\r\n> 4. Test your changes to make sure your code behaves as expected.\r\n\r\n The `updateContact()` function returns a Promise that resolves when the\r\n contact with the specified ID has been updated.\r\n\r\n Only the properties passed in the `ContactInfo` object will\r\n be updated. All other properties will remain the same.","sdkErrors":[]}],"webhooks":[],"articles":[{"content":"# Introduction\nTo use the CRM API, import `wixCrmBackend` from the `wix-crm-backend` module:\n\n ```javascript\n import wixCrmBackend from 'wix-crm-backend';\n ```","displayName":"Introduction","slugifyName":"introduction"}],"namespaces":[{"name":"Contacts","slug":"contacts","fqn":"Contacts","standaloneTypes":[],"metadata":{},"actions":[{"name":"appendOrCreateContact","fqn":"Contacts.appendOrCreateContact","slug":"append-or-create-contact","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["contactInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ContactIdentification","referenceFqn":"Contacts.ContactIdentification"}},"examples":[{"title":"Append or create a contact with a name","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myAppendOrCreateContactFunction = webMethod(Permissions.Anyone, () => {\n const contactInfo = {\n name: {\n first: \"Ari\",\n last: \"Thereyet\"\n }\n };\n\n return contacts.appendOrCreateContact(contactInfo)\n .then((resolvedContact) => {\n return resolvedContact;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* Promise resolves to:\n * {\n * \"contactId\": \"a52852d7-e0d6-484b-93fe-bffdb670f08f\",\n * \"identityType\": \"CONTACT\"\n * }\n */"},{"title":"Append or create a contact, full object","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myAppendOrCreateContactFunction = webMethod(Permissions.Anyone, () => {\n const contactInfo = {\n name: {\n first: \"Ari\",\n last: \"Thereyet\"\n },\n emails: [\n {\n email: \"ari.thereyet@example.com\",\n },\n {\n email: \"ari.thereyet.appended.email@example.com\"\n }\n ],\n phones: [\n {\n tag: \"MOBILE\",\n countryCode: \"US\",\n phone: \"601-081-124\",\n primary: true\n }\n ]\n };\n\n return contacts.appendOrCreateContact(contactInfo)\n .then((resolvedContact) => {\n return resolvedContact;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* Promise resolves to:\n * {\n * \"contactId\": \"a52852d7-e0d6-484b-93fe-bffdb670f08f\",\n * \"identityType\": \"CONTACT\"\n * }\n */"}],"actionParams":[{"name":"contactInfo","slug":"contact-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactInfo","referenceFqn":"Contacts.ContactInfo"},"description":"Contact's information.\r\nTo reconcile with an existing contact,\r\na phone or email must be provided,\r\nor the current session identity must be attached to a contact or member.\r\n\r\nIf no existing contact can be found,\r\na new contact is created with the specified information."}],"description":"Appends `contactInfo` to an existing contact or creates a new contact if it doesn't already exist.\r\n\r\nThe `appendOrCreateContact()` function returns a Promise\r\nthat resolves to a contact ID and identity type when a contact is found or created.\r\n\r\nWhen called, `appendOrCreateContact()` accepts an object with contact information and follows the steps below.\r\nWhen one of the conditions is met, this process ends and the specified\r\ndata is handled:\r\n\r\n1. **If the current visitor is a logged-in member:** `appendOrCreateContact()` reconciles with the member's associated contact.\r\n2. **If the current visitor is not a logged-in member:** `appendOrCreateContact()` tries to reconcile any specified email addresses and/or phone numbers with an existing contact.\r\n3. **If an email address, phone number, and/or name has been provided, but the contact can't be reconciled:** A new contact is created and `appendOrCreateContact()` reconciles with the new contact.\r\n4. **If a contact can't be reconciled by email or phone and a new contact isn't created:** `appendOrCreateContact()` tries to reconcile the visitor's session identity with an existing contact.\r\n5. **If no contact can be created:** The Promise is rejected.\r\n\r\n`appendOrCreateContact()` does not require member authentication,\r\nso it does not return the entire contact object.\r\nThe contact's data can be retrieved with\r\n[`getContact()`](wix-crm-backend/contacts/get-contact).\r\n\r\n#### How the Data is Handled\r\n\r\nIf an **existing contact** is found:\r\n\r\n- The current visitor's session identity is associated with the contact.\r\n- If a specified property is empty in the existing contact, the property is updated with the specified information.\r\n- For arrays, any specified information is added as new array items. This includes `emails`, `addresses`, `phones`, and `labelKeys`.\r\n- No existing data is overwritten or deleted.\r\n\r\n> **Note:**\r\n> If the reconciled contact belongs to a member\r\n> who isn't currently logged in to the site,\r\n> `identityType` is returned as `\"NOT_AUTHENTICATED_MEMBER\"`.\r\n> In that case, no contact properties are modified.\r\n\r\nIf a **new contact** is created:\r\n\r\n- The new contact's data is populated with the specified contact object.\r\n- The current visitor's session identity is associated with the contact.","sdkErrors":[]},{"name":"createContact","fqn":"Contacts.createContact","slug":"create-contact","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["contactInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Contact","referenceFqn":"Contacts.Contact"},"description":"Fulfilled - Contact."},"examples":[{"title":"Create a new contact with a name","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myCreateContactFunction = webMethod(Permissions.Anyone, () => {\n const contactInfo = {\n name: {\n first: \"Ari\",\n last: \"Thereyet\"\n }\n };\n\n const options = {\n allowDuplicates: false,\n suppressAuth: false\n };\n\n return contacts.createContact(contactInfo, options)\n .then((contact) => {\n return contact;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* Promise resolves to:\n * {\n * \"_id\": \"bbc44e99-4439-4a51-ac8c-77d6a9bb6243\",\n * \"_createdDate\": \"2021-07-26T06:32:46.466Z\",\n * \"_updatedDate\": \"2021-07-26T06:32:46.467Z\",\n * \"revision\": 0,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Ari\",\n * \"last\": \"Thereyet\"\n * },\n * \"extendedFields\": {\n * \"contacts.displayByFirstName\": \"Ari Thereyet\",\n * \"contacts.displayByLastName\": \"Thereyet Ari\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-07-26T06:32:46.466Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"source\": {\n * \"appId\": \"v4.createContact\",\n * \"sourceType\": \"OTHER\"\n * }\n * }\n */"},{"title":"Create a new contact, full object","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myCreateContactFunction = webMethod(Permissions.Anyone, () => {\n const contactInfo = {\n name: {\n first: \"Gene\",\n last: \"Lopez\"\n },\n company: \"Borer and Sons, Attorneys at Law\",\n jobTitle: \"Senior Staff Attorney\",\n locale: \"en-US\",\n birthdate: \"1981-11-02\",\n profilePicture: \"https://randomuser.me/api/portraits/men/0.jpg\",\n emails: [\n {\n tag: \"WORK\",\n email: \"gene.lopez@example.com\"\n },\n {\n tag: \"HOME\",\n email: \"gene.lopez.at.home@example.com\",\n primary: true\n }\n ],\n phones: [\n {\n tag: \"HOME\",\n countryCode: \"US\",\n phone: \"(704)-454-1233\"\n },\n {\n tag: \"MOBILE\",\n countryCode: \"US\",\n phone: \"(722)-138-3099\",\n primary: true\n }\n ],\n addresses: [\n {\n tag: \"HOME\",\n address: {\n streetAddress: {\n number: \"9834\",\n name: \"Bollinger Rd\"\n },\n formatted: \"9834 Bollinger Rd\\nEl Cajon, WY 97766\\nUS\",\n location: {\n latitude: \"84.1048\",\n longitude: \"-116.8836\"\n },\n city: \"El Cajon\",\n subdivision: \"WY\",\n country: \"US\",\n postalCode: \"97766\"\n }\n }\n ],\n labelKeys: [\n \"custom.white-glove-treatment\",\n \"contacts.contacted-me\",\n \"custom.new-lead\"\n ],\n extendedFields: {\n \"custom.event-we-met-at\": \"LegalBigData\"\n }\n };\n\n const options = {\n allowDuplicates: false,\n suppressAuth: false\n };\n\n return contacts.createContact(contactInfo, options)\n .then((contact) => {\n return contact;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* Promise resolves to:\n * {\n * \"_id\": \"703d5a66-850d-4ecb-b967-445726a26c15\",\n * \"_createdDate\": \"2021-07-26T07:06:17.685Z\",\n * \"_updatedDate\": \"2021-07-26T07:06:17.686Z\",\n * \"revision\": 0,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Gene\",\n * \"last\": \"Lopez\"\n * },\n * \"profilePicture\": \"https://randomuser.me/api/portraits/men/0.jpg\",\n * \"birthdate\": \"1981-11-02\",\n * \"company\": \"Borer and Sons, Attorneys at Law\",\n * \"jobTitle\": \"Senior Staff Attorney\",\n * \"locale\": \"en-us\",\n * \"emails\": [\n * {\n * \"_id\": \"ead5f037-515b-4e67-bc77-ac1d70f0cdac\",\n * \"tag\": \"HOME\",\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"87a665a4-cde1-4b3c-b164-90e0a7472788\",\n * \"tag\": \"WORK\",\n * \"email\": \"gene.lopez@example.com\",\n * \"primary\": false\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"fada6859-e560-4590-a8bf-226a30537701\",\n * \"tag\": \"MOBILE\",\n * \"countryCode\": \"US\",\n * \"phone\": \"(722)-138-3099\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"51efdd52-71f3-4562-906d-0c7212599f36\",\n * \"tag\": \"HOME\",\n * \"countryCode\": \"US\",\n * \"phone\": \"(704)-454-1233\",\n * \"e164Phone\": \"+17044541233\",\n * \"primary\": false\n * }\n * ],\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"9834 Bollinger Rd\\nEl Cajon, WY 97766\\nUS\",\n * \"location\": {\n * \"latitude\": 84.1048,\n * \"longitude\": -116.8836\n * },\n * \"city\": \"El Cajon\",\n * \"subdivision\": \"US-WY\",\n * \"country\": \"US\",\n * \"postalCode\": \"97766\",\n * \"streetAddress\": {\n * \"name\": \"Bollinger Rd\",\n * \"number\": \"9834\",\n * \"apt\": \"\"\n * }\n * },\n * \"_id\": \"263e25c5-7f7f-4cab-9a4e-768ca74fd891\",\n * \"tag\": \"HOME\"\n * }\n * ],\n * \"labelKeys\": [\n * \"custom.white-glove-treatment\",\n * \"contacts.contacted-me\",\n * \"custom.new-lead\"\n * ],\n * \"extendedFields\": {\n * \"custom.event-we-met-at\": \"LegalBigData\"\n * }\n * },\n * \"primaryInfo\": {\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"phone\": \"(722)-138-3099\"\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-07-26T07:06:17.685Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"source\": {\n * \"appId\": \"151e476a-715e-ec33-db9a-a7ff4d51f70a\",\n * \"sourceType\": \"WIX_APP\"\n * }\n * }\n */"}],"actionParams":[{"name":"contactInfo","slug":"contact-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactInfo","referenceFqn":"Contacts.ContactInfo"},"description":"Contact info."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Options","referenceFqn":"Contacts.Options"},"description":"Contact creation options."}],"description":"Creates a new contact.\r\n\r\n\r\n\r\n\r\nThe `createContact()` function returns a Promise\r\nthat resolves to the new contact when it is created.\r\n\r\n> **Note:**\r\n> This function replaces the deprecated\r\n> `wixCrmBackend.createContact()`.\r\n> The deprecated function will continue to work, but it will not receive updates.\r\n> To keep any existing code compatible with future changes, see the\r\n> [migration instructions](https://dev.wix.com/docs/velo/api-reference/wix-crm-backend/create-contact).\r\n\r\nThe `contactInfo` parameter object must include a name, phone number, or email address.\r\nIf all 3 of these parameters are missing,\r\nthe contact won't be created.\r\n\r\nBy default,\r\nif the call contains an email already in use by another contact,\r\nthe new contact won't be created.\r\nTo override this behavior,\r\nset `allowDuplicates` in the `options` object to `true`.\r\n\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can create contacts.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"deleteContact","fqn":"Contacts.deleteContact","slug":"delete-contact","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["contactId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"Delete a contact","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myDeleteContactFunction = webMethod(Permissions.Anyone, () => {\n const contactId = \"43fd5f9e-d7d4-4a31-8bfc-3bdc180cc40a\";\n const options = {\n suppressAuth: false\n };\n\n return contacts.deleteContact(contactId, options)\n .then(() => {\n console.log(\"Contact deleted\");\n })\n .catch((error) => {\n console.error(error);\n });\n});"}],"actionParams":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the contact to delete."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Deletes a contact who is not a site member or contributor.\r\n\r\n\r\n\r\n\r\nThe `deleteContact()` function returns a Promise\r\nthat resolves when the specified contact is deleted.\r\n\r\n> **Note:**\r\n> This function replaces the deprecated\r\n> `wixCrmBackend.deleteContact()`.\r\n> The deprecated function will continue to work, but it will not receive updates.\r\n> To keep any existing code compatible with future changes, see the\r\n> [migration instructions](https://dev.wix.com/docs/velo/api-reference/wix-crm-backend/delete-contact).\r\n\r\nDeleting a contact permanently removes them from your Contact List.\r\n\r\n\r\nIf the contact is also a site member,\r\nthe member must be deleted first,\r\nand then the contact can be deleted.\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can delete contacts.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"deleteExtendedField","fqn":"Contacts.deleteExtendedField","slug":"delete-extended-field","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["key"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"Delete an extended field","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myDeleteExtendedFieldFunction = webMethod(Permissions.Anyone, () => {\n const fieldKey = \"custom.event-name\";\n const options = {\n suppressAuth: false\n };\n\n return contacts.deleteExtendedField(fieldKey, options)\n .then(() => {\n console.log(\"Extended field deleted\");\n })\n .catch((error) => {\n console.error(error);\n });\n});"}],"actionParams":[{"name":"key","slug":"key","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Extended field ID."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Deletes an extended field.\r\n\r\n\r\nThe `deleteExtendedField()` function returns a Promise that resolves\r\nwhen the specified extended field is deleted.\r\n\r\n\r\nWhen an extended field is deleted,\r\nany contact data stored in the field is permanently deleted as well.\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can delete extended fields.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"deleteLabel","fqn":"Contacts.deleteLabel","slug":"delete-label","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["key"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"Delete a label","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myDeleteLabelFunction = webMethod(Permissions.Anyone, () => {\n const labelKey = \"custom.new-lead\";\n const options = {\n suppressAuth: false\n };\n\n return contacts.deleteLabel(labelKey, options)\n .then(() => {\n console.log(\"Label deleted\");\n })\n .catch((error) => {\n console.error(error);\n });\n});"}],"actionParams":[{"name":"key","slug":"key","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Label key to delete."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Deletes a label from the site and removes it from contacts it applies to.\r\n\r\n\r\nThe `deleteLabel()` function returns a Promise\r\nthat resolves when the specified label is deleted.\r\n\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can delete labels.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"findOrCreateExtendedField","fqn":"Contacts.findOrCreateExtendedField","slug":"find-or-create-extended-field","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["extendedFieldInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"FoundOrCreatedExtendedField","referenceFqn":"Contacts.FoundOrCreatedExtendedField"},"description":"Fulfilled - Extended field that was found or created."},"examples":[{"title":"Create an extended field","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myFindOrCreateExtendedFieldFunction = webMethod(Permissions.Anyone, () => {\n const extendedFieldInfo = {\n displayName: \"Last Contacted\",\n dataType: \"DATE\"\n };\n const options = {\n suppressAuth: false\n };\n\n return contacts.findOrCreateExtendedField(extendedFieldInfo, options)\n .then((extendedField) => {\n return extendedField;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/*\n * Promise that resolves to:\n *\n * {\n * \"extendedField\": {\n * \"_createdDate\": \"2021-01-19T23:18:16.550Z\",\n * \"_updatedDate\": \"2021-01-19T23:18:16.550Z\"\n * \"namespace\": \"custom\",\n * \"key\": \"custom.last-contacted\",\n * \"displayName\": \"Last Contacted\",\n * \"dataType\": \"DATE\",\n * \"fieldType\": \"USER_DEFINED\",\n * },\n * \"newExtendedField\": true\n * }\n */"},{"title":"Find an extended field","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myFindOrCreateExtendedFieldFunction = webMethod(Permissions.Anyone, () => {\n const extendedFieldInfo = {\n displayName: \"Last Contacted\",\n dataType: \"DATE\"\n };\n const options = {\n suppressAuth: false\n };\n\n return contacts.findOrCreateExtendedField(extendedFieldInfo, options)\n .then((extendedField) => {\n return extendedField;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/*\n * Promise resolves to:\n *\n * {\n * \"extendedField\": {\n * \"_createdDate\": \"2021-01-19T23:18:17Z\",\n * \"_updatedDate\": \"2021-01-19T23:18:17Z\"\n * \"namespace\": \"custom\",\n * \"key\": \"custom.last-contacted\",\n * \"displayName\": \"Last Contacted\",\n * \"dataType\": \"DATE\",\n * \"fieldType\": \"USER_DEFINED\",\n * },\n * \"newExtendedField\": false\n * }\n*/"}],"actionParams":[{"name":"extendedFieldInfo","slug":"extended-field-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExtendedFieldInfo","referenceFqn":"Contacts.ExtendedFieldInfo"},"description":"Custom field to find or create."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Retrieves a custom field with a given name, or creates one if it doesn't exist.\r\n\r\n\r\n\r\n\r\nThe `findOrCreateExtendedField()` function returns a Promise\r\nthat resolves when the specified custom field is found or created.\r\n\r\nSuccessful calls to `findOrCreateExtendedField()` always return an\r\n[extended field](wix-crm-backend/contacts/about-extended-fields),\r\nwhich can be passed to subsequent function calls.\r\n\r\nTo find an existing extended field without potentially creating a new one, use\r\n[`getExtendedField()`](wix-crm-backend/contacts/get-extended-field) or\r\n[`queryExtendedFields()`](wix-crm-backend/contacts/query-extended-fields).\r\n\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can find or create extended fields.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"findOrCreateLabel","fqn":"Contacts.findOrCreateLabel","slug":"find-or-create-label","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["displayName"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"FoundOrCreatedLabel","referenceFqn":"Contacts.FoundOrCreatedLabel"},"description":"Fulfilled - Label that was found or created."},"examples":[{"title":"Create a label","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myFindOrCreateLabelFunction = webMethod(Permissions.Anyone, () => {\n const displayName = \"Active Customer\";\n const options = {\n suppressAuth: false\n };\n\n return contacts.findOrCreateLabel(displayName, options)\n .then((label) => {\n return label;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/*\n * Promise resolves to:\n *\n * {\n * \"label\": {\n * \"_createdDate\": \"2021-01-20T00:31:41.452Z\",\n * \"_updatedDate\": \"2021-01-20T00:31:41.452Z\"\n * \"namespace\": \"custom\",\n * \"key\": \"custom.active-customer\",\n * \"displayName\": \"Active Customer\",\n * \"labelType\": \"USER_DEFINED\"\n * },\n * \"newLabel\": true\n * }\n */"},{"title":"Find a label","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myFindOrCreateLabelFunction = webMethod(Permissions.Anyone, () => {\n const displayName = \"Active Customer\";\n const options = {\n suppressAuth: false\n };\n\n return contacts.findOrCreateLabel(displayName, options)\n .then((label) => {\n return label;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/*\n * Promise resolves to:\n *\n * {\n * \"label\": {\n * \"_createdDate\": \"2021-01-20T00:31:41.452Z\",\n * \"_updatedDate\": \"2021-01-20T00:31:41.452Z\"\n * \"namespace\": \"custom\",\n * \"key\": \"custom.active-customer\",\n * \"displayName\": \"Active Customer\",\n * \"labelType\": \"USER_DEFINED\"\n * },\n * \"newLabel\": true\n * }\n */"}],"actionParams":[{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Label display name to retrieve or create.\r\n\r\n If an existing label is an exact match\r\n for the specified display name,\r\n the existing label is returned.\r\n If not, a new label is created and returned."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Retrieves a label with a given name, or creates one if it doesn't exist.\r\n\r\n\r\n\r\n\r\nThe `findOrCreateLabel()` function returns a Promise\r\nthat resolves when the specified label is found or created.\r\n\r\nSuccessful calls to `findOrCreateLabel()` always return a label,\r\nwhich can be passed to subsequent function calls.\r\n\r\nTo find an existing label without potentially creating a new one, use\r\n[`getLabel()`](wix-crm-backend/contacts/get-label) or\r\n[`queryLabels()`](wix-crm-backend/contacts/query-labels).\r\n\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can find or create labels.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"getContact","fqn":"Contacts.getContact","slug":"get-contact","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["contactId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Contact","referenceFqn":"Contacts.Contact"},"description":"Fulfilled - The requested contact."},"examples":[{"title":"Get a contact","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myGetContactFunction = webMethod(Permissions.Anyone, () => {\n const contactId = \"bc0ae72b-3285-485b-b0ad-c32c769a4daf\";\n const options = {\n suppressAuth: false\n };\n\n return contacts.getContact(contactId, options)\n .then((contact) => {\n return contact;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* Promise resolves to:\n * {\n * \"_id\": \"bc0ae72b-3285-485b-b0ad-c32c769a4daf\",\n * \"_createdDate\": \"2021-03-30T13:12:39.650Z\",\n * \"_updatedDate\": \"2021-03-30T13:12:39.650Z\",\n * \"revision\": 0,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Gene\",\n * \"last\": \"Lopez\"\n * },\n * \"birthdate\": \"1981-11-02\",\n * \"company\": \"Borer and Sons, Attorneys at Law\",\n * \"jobTitle\": \"Senior Staff Attorney\",\n * \"labelKeys\": [\n * \"custom.white-glove-treatment\",\n * \"contacts.contacted-me\",\n * \"custom.new-lead\"\n * ],\n * \"locale\": \"en-us\",\n * \"emails\": [\n * {\n * \"_id\": \"5bdcce4a-37c2-46ed-b49c-d562c6e3c4ce\",\n * \"tag\": \"HOME\",\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"78e5f398-e148-448d-b490-7c0b7d2ab336\",\n * \"tag\": \"WORK\",\n * \"email\": \"gene.lopez@example.com\",\n * \"primary\": false\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"820e4640-ffe0-4980-a097-62a715e73135\",\n * \"tag\": \"MOBILE\",\n * \"countryCode\": \"US\",\n * \"phone\": \"(722)-138-3099\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"8506549e-e4f8-42f6-b6fc-9db155b582ef\",\n * \"tag\": \"HOME\",\n * \"countryCode\": \"US\",\n * \"phone\": \"(704)-454-1233\",\n * \"e164Phone\": \"+17044541233\",\n * \"primary\": false\n * }\n * ],\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"9834 Bollinger Rd\\nEl Cajon, WY 97766\\nUS\",\n * \"location\": {\n * \"latitude\": 84.1048,\n * \"longitude\": -116.8836\n * },\n * \"city\": \"El Cajon\",\n * \"subdivision\": \"US-WY\",\n * \"country\": \"US\",\n * \"postalCode\": \"97766\",\n * \"streetAddress\": {\n * \"name\": \"Bollinger Rd\",\n * \"number\": \"9834\",\n * \"apt\": \"\"\n * }\n * },\n * \"_id\": \"8532051f-91f2-42d9-9a97-9f2c39e64f7a\",\n * \"tag\": \"HOME\"\n * }\n * ],\n * \"profilePicture\": \"https://randomuser.me/api/portraits/men/0.jpg\",\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Lopez Gene\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"custom.event-we-met-at\": \"LegalBigData\",\n * \"emailSubscriptions.effectiveEmail\": \"gene.lopez.at.home@example.com\",\n * \"contacts.displayByFirstName\": \"Gene Lopez\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-30T13:12:39.649Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"primaryInfo\": {\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"phone\": \"(722)-138-3099\"\n * },\n * \"source\": {\n * \"sourceType\": \"OTHER\"\n * }\n * }\n */"},{"title":"Get a contact's latest revision number, then update","description":"The page code passes a contact ID and updated contact information\nto the backend `overwriteContactInfo()` function.\n`overwriteContactInfo()` then retrieves the contact,\nextracts the revision number, and passes it to `contacts.updateContact()`.\nThis ensures that the contact is always updated\nwithout needing to specify the revision.\n\nThis can be used when it's not important that some contact information could be overwritten.","content":"/*******************************\n * Backend code - contacts.web.js *\n *******************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const overwriteContactInfo = webMethod(Permissions.Anyone, async (contactId, updatedContactInfo) => {\n\n // Get the contact's last revision number\n const myContact = await contacts.getContact(contactId);\n const contactIdentifiers = {\n contactId: contactId,\n revision: myContact.revision\n };\n const options = {\n allowDuplicates: false,\n suppressAuth: false\n };\n\n return await contacts.updateContact(contactIdentifiers, updatedContactInfo, options);\n});\n\n/*************\n * Page code *\n *************/\n\nimport { overwriteContactInfo } from 'backend/contacts.web';\n\n// ...\n\nconst contactId = \"0677ef55-cf20-4f68-989a-f31d3649eb72\";\n\nconst updatedContactInfo = {\n name: {\n first: \"Annie\",\n last: \"New Name\"\n }\n};\n\noverwriteContactInfo(contactId, updatedContactInfo)\n .then((updatedContact) => {\n return updatedContact;\n })\n .catch((error) => {\n console.error(error);\n });\n\n/* Updated contact resolves to:\n * {\n * \"_id\": \"0677ef55-cf20-4f68-989a-f31d3649eb72\",\n * \"_createdDate\": \"2021-03-31T20:24:48.393Z\",\n * \"_updatedDate\": \"2021-03-31T20:29:14.519Z\",\n * \"revision\": 4,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Annie\",\n * \"last\": \"New Name\"\n * },\n * \"extendedFields\": {\n * \"contacts.displayByFirstName\": \"Annie New Name\",\n * \"contacts.displayByLastName\": \"New Name Annie\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-31T20:24:48.393Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"source\": {\n * \"appId\": \"manual\",\n * \"sourceType\": \"ADMIN\"\n * }\n * }\n */\n"},{"title":"Get a merged source contact","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\n/* Sample contactId value:\n * 'c8e08afd-deac-40f7-b4c1-b42409d35df7'\n */\n\nexport const myGetContactFunction = webMethod(Permissions.Anyone, async (contactId) => {\n try {\n const retrievedContact = await contacts.getContact(contactId);\n const retrievedContactId = retrievedContact._id;\n\n if (retrievedContactId !== contactId) {\n console.log(`Merged target contact ${retrievedContactId} returned. The requested contact was deleted in the merge.`);\n }\n\n return retrievedContact;\n\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n\n});\n\n/* Promise resolves to:\n * {\n * \"_id\": \"49c5d809-6bc8-40b1-86e7-4bf3f6d17adb\",\n * \"_createdDate\": \"2022-02-02T21:41:03.313Z\",\n * \"_updatedDate\": \"2022-02-02T21:52:00.048Z\",\n * \"revision\": 6,\n * \"lastActivity\": {\n * \"activityDate\": \"2022-02-02T21:51:59.952Z\",\n * \"activityType\": \"CONTACT_MERGED\"\n * },\n * \"primaryInfo\": {\n * \"email\": \"target.contact@example.com\",\n * \"phone\": \"62183848\"\n * },\n * \"info\": {\n * \"name\": {\n * \"first\": \"Updated Target\"\n * },\n * \"emails\": [\n * {\n * \"_id\": \"81109065-7b9e-4b99-b146-b523eb5338ca\",\n * \"tag\": \"HOME\",\n * \"email\": \"target.contact@example.com\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"cd9ea33c-4358-457f-bd99-4384cf5f83c2\",\n * \"tag\": \"WORK\",\n * \"email\": \"source.contact@example.com\",\n * \"primary\": false\n * }\n * ],\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"4197 Existing Street Address\\nHovedstaden Klitmøller\\nDenmark\",\n * \"city\": \"Klitmøller\",\n * \"country\": \"DK\",\n * \"postalCode\": \"Hovedstaden\",\n * \"addressLine1\": \"4197 Existing Street Address\"\n * },\n * \"_id\": \"a3455bd0-76af-427c-9adc-8d384193f347\",\n * \"tag\": \"HOME\"\n * },\n * {\n * \"address\": {\n * \"formatted\": \"9278 Source Street\\n31562 København S\\nDenmark\",\n * \"city\": \"København S\",\n * \"subdivision\": \"DK-82\",\n * \"country\": \"DK\",\n * \"postalCode\": \"31562\",\n * \"addressLine1\": \"9278 Source Street\"\n * },\n * \"_id\": \"c3bb555c-a543-4e0a-86e3-341ced30666c\",\n * \"tag\": \"WORK\"\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"5a53acb4-fd19-411e-93f3-3bd7ca8f9df8\",\n * \"tag\": \"HOME\",\n * \"countryCode\": \"DK\",\n * \"phone\": \"62183848\",\n * \"e164Phone\": \"+4562183848\",\n * \"formattedPhone\": \"+45 62183848\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"b98e5caf-95d6-4fab-b80c-267431b82344\",\n * \"tag\": \"WORK\",\n * \"countryCode\": \"DK\",\n * \"phone\": \"64498094\",\n * \"e164Phone\": \"+4564498094\",\n * \"formattedPhone\": \"+45 64498094\",\n * \"primary\": false\n * }\n * ],\n * \"labelKeys\": [\n * \"contacts.contacted-me\"\n * ],\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Updated Target\",\n * \"invoices.vatId\": \"\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"emailSubscriptions.effectiveEmail\": \"source.contact@example.com\",\n * \"contacts.displayByFirstName\": \"Updated Target\"\n * },\n * \"profilePicture\": \"https://img-wixmp-8be454c954980f083caba37c.wixmp.com/sites/7b940519-404c-4972-9f03-9a430b68d52c/49c5d809-6bc8-40b1-86e7-4bf3f6d17adb/ecb8b31b-845c-4bc6-b868-73df78a92313-avatar-v2.jpeg::fil:100_100\"\n * },\n * \"source\": {\n * \"sourceType\": \"ADMIN\"\n * }\n */"}],"actionParams":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the contact to retrieve."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Retrieves a contact.\r\n\r\nThe `getContact()` function returns a Promise\r\nthat resolves when the contact is found.\r\n\r\n#### Getting Merged Contacts\r\n\r\nWhen a source contact is merged\r\nwith a target contact, the source contact is deleted.\r\nWhen calling `getContact()` for a merged contact,\r\nyou can use the source or target contact ID.\r\nIn both cases, the target contact is returned.\r\n\r\nThis is supported only when calling `getContact()`,\r\nand only for merged contacts.\r\nDeleted source contact IDs are not supported on any other function.\r\n\r\n> **Notes:**\r\n>\r\n> - This function replaces the deprecated\r\n> `wixCrmBackend.getContactById()`.\r\n> The deprecated function will continue to work, but it will not receive updates.\r\n> To keep any existing code compatible with future changes, see the\r\n> [migration instructions](https://dev.wix.com/docs/velo/api-reference/wix-crm-backend/get-contact-by-id).\r\n> - Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can retrieve contacts.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"getExtendedField","fqn":"Contacts.getExtendedField","slug":"get-extended-field","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["key"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ExtendedField","referenceFqn":"Contacts.ExtendedField"},"description":"Fulfilled - The specified field."},"examples":[{"title":"Get an extended field","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myGetExtendedFieldFunction = webMethod(Permissions.Anyone, () => {\n const fieldKey = \"custom.event-name\";\n const options = {\n suppressAuth: false\n };\n\n return contacts.getExtendedField(fieldKey, options)\n .then((extendedField) => {\n return extendedField;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/*\n * Promise resolves to:\n *\n * {\n * \"_createdDate\": \"2021-01-19T21:41:39Z\",\n * \"_updatedDate\": \"2021-01-19T21:41:39Z\"\n * \"namespace\": \"custom\",\n * \"key\": \"custom.event-name\",\n * \"displayName\": \"Event Name\",\n * \"dataType\": \"TEXT\",\n * \"fieldType\": \"USER_DEFINED\",\n * }\n */"}],"actionParams":[{"name":"key","slug":"key","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Extended field ID\r\n.\r\n\r\n\r\n\r\n\r\nWhen accessing contact data,\r\nextended field values are available at `extendedFields[key]`.\r\nFor example, if the key is \"custom.notes\",\r\nthe value can be accessed at `extendedfields[\"custom.notes\"]`.\r\n\r\n\r\nOnce set, `key` cannot be modified, even if `displayName` changes."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Retrieves an extended field.\r\n\r\n\r\nThe `getExtendedField()` function returns a Promise\r\nthat resolves when the extended field is retrieved.\r\n\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can retrieve extended fields.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"getLabel","fqn":"Contacts.getLabel","slug":"get-label","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["key"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Label","referenceFqn":"Contacts.Label"},"description":"Fulfilled - The specified label."},"examples":[{"title":"Get a label","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myGetLabelFunction = webMethod(Permissions.Anyone, () => {\n const labelKey = \"custom.active-customer\";\n const options = {\n suppressAuth: false\n };\n\n return contacts.getLabel(labelKey, options)\n .then((label) => {\n return label;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/*\n * Promise resolves to:\n *\n * {\n * \"_createdDate\": \"2021-01-20T00:31:41Z\",\n * \"_updatedDate\": \"2021-01-20T00:31:41Z\"\n * \"namespace\": \"custom\",\n * \"key\": \"custom.active-customer\",\n * \"displayName\": \"Active Customer\",\n * \"labelType\": \"USER_DEFINED\"\n * }\n */"}],"actionParams":[{"name":"key","slug":"key","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Label key.\r\n\r\n`key` is generated when the label is created\r\nand cannot be modified, even if `displayName` changes."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Retrieves a label.\r\n\r\n\r\nThe `getLabel()` function returns a Promise\r\nthat resolves when the specified label is retrieved.\r\n\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can retrieve labels.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"labelContact","fqn":"Contacts.labelContact","slug":"label-contact","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["contactId","labelKeys"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Contact","referenceFqn":"Contacts.Contact"},"description":"Fulfilled - Updated contact."},"examples":[{"title":"Label a contact","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myLabelContactFunction = webMethod(Permissions.Anyone, () => {\n const contactId = \"bc0ae72b-3285-485b-b0ad-c32c769a4daf\";\n const labelKeys = [\n \"custom.at-risk\",\n \"custom.white-glove-treatment\"\n ];\n const options = {\n suppressAuth: false\n };\n\n return contacts.labelContact(contactId, labelKeys, options)\n .then((labeledContact) => {\n return labeledContact;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* Promise resolves to:\n * {\n * \"_id\": \"bc0ae72b-3285-485b-b0ad-c32c769a4daf\",\n * \"_createdDate\": \"2021-03-30T13:12:39.650Z\",\n * \"_updatedDate\": \"2021-04-07T21:01:25.892Z\",\n * \"revision\": 1,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Gene\",\n * \"last\": \"Lopez\"\n * },\n * \"birthdate\": \"1981-11-02\",\n * \"jobTitle\": \"Senior Staff Attorney\",\n * \"company\": \"Borer and Sons, Attorneys at Law\",\n * \"locale\": \"en-us\",\n * \"profilePicture\": \"https://randomuser.me/api/portraits/men/0.jpg\",\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"9834 Bollinger Rd\\nEl Cajon, WY 97766\\nUS\",\n * \"location\": {\n * \"latitude\": 84.1048,\n * \"longitude\": -116.8836\n * },\n * \"city\": \"El Cajon\",\n * \"subdivision\": \"US-WY\",\n * \"country\": \"US\",\n * \"postalCode\": \"97766\",\n * \"streetAddress\": {\n * \"name\": \"Bollinger Rd\",\n * \"number\": \"9834\",\n * \"apt\": \"\"\n * }\n * },\n * \"_id\": \"8532051f-91f2-42d9-9a97-9f2c39e64f7a\",\n * \"tag\": \"HOME\"\n * }\n * ],\n * \"emails\": [\n * {\n * \"_id\": \"5bdcce4a-37c2-46ed-b49c-d562c6e3c4ce\",\n * \"tag\": \"HOME\",\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"78e5f398-e148-448d-b490-7c0b7d2ab336\",\n * \"tag\": \"WORK\",\n * \"email\": \"gene.lopez@example.com\",\n * \"primary\": false\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"820e4640-ffe0-4980-a097-62a715e73135\",\n * \"tag\": \"MOBILE\",\n * \"countryCode\": \"US\",\n * \"phone\": \"(722)-138-3099\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"8506549e-e4f8-42f6-b6fc-9db155b582ef\",\n * \"tag\": \"HOME\",\n * \"countryCode\": \"US\",\n * \"phone\": \"(704)-454-1233\",\n * \"e164Phone\": \"+17044541233\",\n * \"primary\": false\n * }\n * ],\n * \"labelKeys\": [\n * \"custom.white-glove-treatment\",\n * \"contacts.contacted-me\",\n * \"custom.new-lead\",\n * \"custom.at-risk\"\n * ],\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Lopez Gene\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"custom.event-we-met-at\": \"LegalBigData\",\n * \"emailSubscriptions.effectiveEmail\": \"gene.lopez.at.home@example.com\",\n * \"contacts.displayByFirstName\": \"Gene Lopez\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-30T13:12:39.649Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"primaryInfo\": {\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"phone\": \"(722)-138-3099\"\n * },\n * \"source\": {\n * \"sourceType\": \"OTHER\"\n * }\n * }\n */"}],"actionParams":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the contact to add labels to."},{"name":"labelKeys","slug":"label-keys","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of label keys to add to the contact.\r\n\r\n\r\n\r\n\r\nLabel keys must exist to be added to the contact.\r\nContact labels can be created or retrieved with\r\n[`findOrCreateLabel()`](wix-crm-backend/contacts/find-or-create-label)\r\nor\r\n[`queryLabels()`](https://dev.wix.com/docs/velo/api-reference/wix-crm-backend/contacts/query-labels)."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Adds labels to a contact.\r\n\r\n\r\n\r\n\r\nThe `labelContact()` function returns a Promise\r\nthat resolves when the specified labels are added to the contact.\r\n\r\n- **To create new labels:** Use [`findOrCreateLabel()`](wix-crm-backend/contacts/find-or-create-label).\r\n- **To find labels:** Use [`findOrCreateLabel()`](wix-crm-backend/contacts/find-or-create-label), [`getLabel()`](wix-crm-backend/contacts/get-label), or [`queryLabels()`](wix-crm-backend/contacts/query-labels).\r\n\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can label contacts.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"queryContacts","fqn":"Contacts.queryContacts","slug":"query-contacts","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Retrieve all contacts","content":"import { contacts } from 'wix-crm-backend';\n\n/* Sample options value:\n * {\n * suppressAuth: true\n * }\n */\n\nexport async function myQueryContactsFunction(options) {\n try {\n\n const queryResults = await contacts.queryContacts().find(options);\n const items = queryResults.items;\n const firstItem = items[0];\n const pageSize = queryResults.pageSize;\n const hasNext = queryResults.hasNext();\n const hasPrev = queryResults.hasPrev();\n const length = queryResults.length;\n const query = queryResults.query;\n\n return items;\n\n } catch (error) {\n\n console.error(error);\n // Handle the error\n\n }\n}\n\n/* Returns items:\n * [\n * {\n * \"_id\": \"f1a481a0-ec7d-48e4-b578-80535bac3e58\",\n * \"_createdDate\": \"2021-04-08T14:15:46.428Z\",\n * \"_updatedDate\": \"2021-04-08T14:17:01.628Z\",\n * \"revision\": 4,\n * \"primaryInfo\": {\n * \"email\": \"tom.watts@example.com\",\n * \"phone\": \"0769-469-693\"\n * },\n * \"info\": {\n * \"name\": {\n * \"first\": \"Tom\",\n * \"last\": \"Watts\"\n * },\n * \"profilePicture\": \"https://wixmp-8be454c954980f083caba37c.wixmp.com/sites/7b940519-404c-4972-9f03-9a430b68d52c/f1a481a0-ec7d-48e4-b578-80535bac3e58/avatar.jpeg?token=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1cm46YXBwOmY1ODg2NzI1MzJlMzQxZmFhZDQwZjFiMDc3MTZhMjU3IiwiYXVkIjpbInVybjpzZXJ2aWNlOmZpbGUuZG93bmxvYWQiXSwib2JqIjpbW3sicGF0aCI6Ii9zaXRlcy83Yjk0MDUxOS00MDRjLTQ5NzItOWYwMy05YTQzMGI2OGQ1MmMvZjFhNDgxYTAtZWM3ZC00OGU0LWI1NzgtODA1MzViYWMzZTU4L2F2YXRhci5qcGVnIn1dXSwiaXNzIjoidXJuOmFwcDpmNTg4NjcyNTMyZTM0MWZhYWQ0MGYxYjA3NzE2YTI1NyIsImV4cCI6MTYxNzg5MjE0NCwiaWF0IjoxNjE3ODkxNTM0LCJqdGkiOiIyQzg3NkZFMDNDNDUifQ.iJxQyNnvpHMLhDiZ-l5hFLr6vMnT10r2Ly6X25U-v-0\",\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"1105 Albert Road\\nCoventry, England\\nTZ7 3JQ\\nUnited Kingdom\",\n * \"city\": \"Coventry\",\n * \"subdivision\": \"GB-ENG\",\n * \"country\": \"GB\",\n * \"postalCode\": \"TZ7 3JQ\",\n * \"addressLine1\": \"1105 Albert Road\"\n * },\n * \"_id\": \"be7eb0fd-78b7-4e3e-ac5e-483925dc9221\",\n * \"tag\": \"HOME\"\n * }\n * ],\n * \"emails\": [\n * {\n * \"_id\": \"09ea3abc-02e0-44c2-a139-f68ce70b9dcc\",\n * \"tag\": \"MAIN\",\n * \"email\": \"tom.watts@example.com\",\n * \"primary\": true\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"8c8d0f51-41fa-48a1-a68e-739d75fb64e0\",\n * \"tag\": \"MOBILE\",\n * \"phone\": \"0769-469-693\",\n * \"primary\": true\n * }\n * ],\n * \"extendedFields\": {\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"UNSUBSCRIBED\",\n * \"contacts.displayByFirstName\": \"Tom Watts\",\n * \"contacts.displayByLastName\": \"Watts Tom\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-04-08T14:17:01.211Z\",\n * \"activityType\": \"INBOX_MESSAGE_TO_CUSTOMER\"\n * },\n * \"source\": {\n * \"sourceType\": \"ADMIN\"\n * }\n * },\n * {\n * \"_id\": \"bb9d8ff5-aa46-483c-ad22-077927b28092\",\n * \"_createdDate\": \"2021-04-08T13:58:32.258Z\",\n * \"_updatedDate\": \"2021-04-08T14:03:56.405Z\",\n * \"revision\": 2,\n * \"primaryInfo\": {\n * \"email\": \"victoria.patterson@example.com\",\n * \"phone\": \"013873 00176\"\n * },\n * \"info\": {\n * \"name\": {\n * \"first\": \"Victoria\",\n * \"last\": \"Patterson\"\n * },\n * \"profilePicture\": \"https://wixmp-8be454c954980f083caba37c.wixmp.com/sites/7b940519-404c-4972-9f03-9a430b68d52c/bb9d8ff5-aa46-483c-ad22-077927b28092/avatar.jpeg?token=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1cm46YXBwOmY1ODg2NzI1MzJlMzQxZmFhZDQwZjFiMDc3MTZhMjU3IiwiYXVkIjpbInVybjpzZXJ2aWNlOmZpbGUuZG93bmxvYWQiXSwib2JqIjpbW3sicGF0aCI6Ii9zaXRlcy83Yjk0MDUxOS00MDRjLTQ5NzItOWYwMy05YTQzMGI2OGQ1MmMvYmI5ZDhmZjUtYWE0Ni00ODNjLWFkMjItMDc3OTI3YjI4MDkyL2F2YXRhci5qcGVnIn1dXSwiaXNzIjoidXJuOmFwcDpmNTg4NjcyNTMyZTM0MWZhYWQ0MGYxYjA3NzE2YTI1NyIsImV4cCI6MTYxNzg5MjE0NCwiaWF0IjoxNjE3ODkxNTM0LCJqdGkiOiIyNTIwNTZEQkExNTEifQ._4JAr9X_g6yPHj_N4JG3OKk33ZbveMMyPbx2D5U2Z4E\",\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"4109 London Road\\nArmagh, Northern Ireland\\nM0N 4GU\\nUnited Kingdom\",\n * \"city\": \"Armagh\",\n * \"subdivision\": \"GB-NIR\",\n * \"country\": \"GB\",\n * \"postalCode\": \"M0N 4GU\",\n * \"addressLine1\": \"4109 London Road\"\n * },\n * \"_id\": \"9e5afe34-6919-432b-bd01-91ee6ead9121\",\n * \"tag\": \"UNTAGGED\"\n * }\n * ],\n * \"emails\": [\n * {\n * \"_id\": \"af757e47-df85-4815-8c99-f1e11033fcc6\",\n * \"tag\": \"UNTAGGED\",\n * \"email\": \"victoria.patterson@example.com\",\n * \"primary\": true\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"a590ae95-8f06-4d71-afcd-1f6f4b5de1b9\",\n * \"tag\": \"HOME\",\n * \"phone\": \"013873 00176\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"d6370be9-386d-4362-add0-b464b818a942\",\n * \"tag\": \"MOBILE\",\n * \"phone\": \"0753-893-447\",\n * \"primary\": false\n * }\n * ],\n * \"labelKeys\": [\n * \"custom.incoming-leads\"\n * ],\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Patterson Victoria\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"emailSubscriptions.effectiveEmail\": \"victoria.patterson@example.com\",\n * \"contacts.displayByFirstName\": \"Victoria Patterson\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-04-08T13:58:32.256Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"source\": {\n * \"sourceType\": \"ADMIN\"\n * }\n * },\n * {\n * \"_id\": \"a52852d7-e0d6-484b-93fe-bffdb670f08f\",\n * \"_createdDate\": \"2021-03-30T20:18:06.874Z\",\n * \"_updatedDate\": \"2021-03-31T20:24:12.312Z\",\n * \"revision\": 5,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Ari\",\n * \"last\": \"Thereyet\"\n * },\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Thereyet Ari\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"emailSubscriptions.effectiveEmail\": \"ari.thereyet.appended.email@example.com\",\n * \"contacts.displayByFirstName\": \"Ari Thereyet\"\n * },\n * \"emails\": [\n * {\n * \"_id\": \"e6f2733e-32b8-4d99-95ce-7d2e63a39108\",\n * \"tag\": \"HOME\",\n * \"email\": \"ari.thereyet@example.com\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"703f6faf-7d88-42ce-8e28-54f8d5f6e5e4\",\n * \"tag\": \"UNTAGGED\",\n * \"email\": \"ari.thereyet.appended.email@example.com\",\n * \"primary\": false\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"970380bb-57e0-4b3a-8f40-ccc93be1ab58\",\n * \"tag\": \"MOBILE\",\n * \"phone\": \"601-081-124\",\n * \"primary\": true\n * }\n * ],\n * \"labelKeys\": [\n * \"custom.stale-lead\"\n * ]\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-30T20:18:06.872Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"primaryInfo\": {\n * \"email\": \"ari.thereyet@example.com\",\n * \"phone\": \"601-081-124\"\n * },\n * \"source\": {\n * \"sourceType\": \"WIX_APP\"\n * }\n * },\n * {\n * \"_id\": \"bc0ae72b-3285-485b-b0ad-c32c769a4daf\",\n * \"_createdDate\": \"2021-03-30T13:12:39.650Z\",\n * \"_updatedDate\": \"2021-04-07T21:03:39.481Z\",\n * \"revision\": 2,\n * \"primaryInfo\": {\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"phone\": \"(722)-138-3099\"\n * },\n * \"info\": {\n * \"name\": {\n * \"first\": \"Gene\",\n * \"last\": \"Lopez\"\n * },\n * \"birthdate\": \"1981-11-02\",\n * \"jobTitle\": \"Senior Staff Attorney\",\n * \"company\": \"Borer and Sons, Attorneys at Law\",\n * \"locale\": \"en-us\",\n * \"profilePicture\": \"https://randomuser.me/api/portraits/men/0.jpg\",\n * \"emails\": [\n * {\n * \"_id\": \"5bdcce4a-37c2-46ed-b49c-d562c6e3c4ce\",\n * \"tag\": \"HOME\",\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"78e5f398-e148-448d-b490-7c0b7d2ab336\",\n * \"tag\": \"WORK\",\n * \"email\": \"gene.lopez@example.com\",\n * \"primary\": false\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"820e4640-ffe0-4980-a097-62a715e73135\",\n * \"tag\": \"MOBILE\",\n * \"countryCode\": \"US\",\n * \"phone\": \"(722)-138-3099\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"8506549e-e4f8-42f6-b6fc-9db155b582ef\",\n * \"tag\": \"HOME\",\n * \"countryCode\": \"US\",\n * \"phone\": \"(704)-454-1233\",\n * \"e164Phone\": \"+17044541233\",\n * \"primary\": false\n * }\n * ],\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"9834 Bollinger Rd\\nEl Cajon, WY 97766\\nUS\",\n * \"location\": {\n * \"latitude\": 84.1048,\n * \"longitude\": -116.8836\n * },\n * \"city\": \"El Cajon\",\n * \"subdivision\": \"US-WY\",\n * \"country\": \"US\",\n * \"postalCode\": \"97766\",\n * \"streetAddress\": {\n * \"name\": \"Bollinger Rd\",\n * \"number\": \"9834\",\n * \"apt\": \"\"\n * }\n * },\n * \"_id\": \"8532051f-91f2-42d9-9a97-9f2c39e64f7a\",\n * \"tag\": \"HOME\"\n * }\n * ],\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Lopez Gene\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"custom.event-we-met-at\": \"LegalBigData\",\n * \"emailSubscriptions.effectiveEmail\": \"gene.lopez.at.home@example.com\",\n * \"contacts.displayByFirstName\": \"Gene Lopez\"\n * },\n * \"labelKeys\": [\n * \"contacts.contacted-me\",\n * \"custom.new-lead\"\n * ]\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-30T13:12:39.649Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"source\": {\n * \"sourceType\": \"OTHER\"\n * }\n * },\n * {\n * \"_id\": \"41b1c8e7-5ddd-4186-ad85-269985d6b296\",\n * \"_createdDate\": \"2021-03-29T21:16:54.801Z\",\n * \"_updatedDate\": \"2021-03-30T20:14:16.256Z\",\n * \"revision\": 3,\n * \"primaryInfo\": {\n * \"email\": \"renata.kirsten@example.com\",\n * \"phone\": \"0177-3234750\"\n * },\n * \"info\": {\n * \"name\": {\n * \"first\": \"Renata\",\n * \"last\": \"Kirsten\"\n * },\n * \"emails\": [\n * {\n * \"_id\": \"500569e4-144d-4f25-83a1-4a59956b698d\",\n * \"tag\": \"UNTAGGED\",\n * \"email\": \"renata.kirsten@example.com\",\n * \"primary\": true\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"3ea63681-598a-45bc-88fb-97fefdfd5a74\",\n * \"tag\": \"UNTAGGED\",\n * \"phone\": \"0177-3234750\",\n * \"primary\": true\n * }\n * ],\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"6677 Schlossstraße\\n48435 Wittenberg\\nGermany\",\n * \"city\": \"Wittenberg\",\n * \"subdivision\": \"DE-TH\",\n * \"country\": \"DE\",\n * \"postalCode\": \"48435\",\n * \"addressLine1\": \"6677 Schlossstraße\"\n * },\n * \"_id\": \"b36d1a2d-9a6b-48c3-a463-c8b116303e9f\",\n * \"tag\": \"SHIPPING\"\n * },\n * {\n * \"address\": {\n * \"formatted\": \"6677 Schlossstraße\\n48435 Wittenberg\\nGermany\",\n * \"city\": \"Wittenberg\",\n * \"subdivision\": \"DE-TH\",\n * \"country\": \"DE\",\n * \"postalCode\": \"48435\",\n * \"addressLine1\": \"6677 Schlossstraße\"\n * },\n * \"_id\": \"2a3fc791-cbad-4ecd-8bf6-8072b2793e3a\",\n * \"tag\": \"BILLING\"\n * }\n * ],\n * \"labelKeys\": [\n * \"contacts.customers\"\n * ],\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Kirsten Renata\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"ecom.lastPurchaseDate\": \"2021-03-29T21:17:01.122Z\",\n * \"ecom.numOfPurchases\": 1,\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"ecom.totalSpentAmount\": 120,\n * \"emailSubscriptions.effectiveEmail\": \"renata.kirsten@example.com\",\n * \"contacts.displayByFirstName\": \"Renata Kirsten\",\n * \"ecom.totalSpentCurrency\": \"ILS\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-29T21:17:01.122Z\",\n * \"activityType\": \"ECOM_PURCHASE\"\n * },\n * \"source\": {\n * \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n * \"sourceType\": \"WIX_STORES\"\n * }\n * },\n * {\n * \"_id\": \"67bcea88-b748-4cc8-a584-bb991b6e5d82\",\n * \"_createdDate\": \"2021-03-29T21:06:53.976Z\",\n * \"_updatedDate\": \"2021-03-29T21:06:53.976Z\",\n * \"revision\": 0,\n * \"primaryInfo\": {\n * \"email\": \"ljiljana.francois@example.com\"\n * },\n * \"info\": {\n * \"name\": {\n * \"first\": \"Ljiljana\",\n * \"last\": \"Francois\"\n * },\n * \"birthdate\": \"1981-09-13\",\n * \"jobTitle\": \"Creative Director\",\n * \"company\": \"Happy Mouse Productions\",\n * \"locale\": \"en-us\",\n * \"emails\": [\n * {\n * \"_id\": \"c030ed4c-e127-4f02-8256-8984415e0321\",\n * \"tag\": \"MAIN\",\n * \"email\": \"ljiljana.francois@example.com\",\n * \"primary\": true\n * }\n * ],\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Francois Ljiljana\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"emailSubscriptions.effectiveEmail\": \"ljiljana.francois@example.com\",\n * \"contacts.displayByFirstName\": \"Ljiljana Francois\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-29T21:06:53.975Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"source\": {\n * \"sourceType\": \"OTHER\"\n * }\n * },\n * {\n * \"_id\": \"1626081c-3b3c-4b44-855b-1acb1122e080\",\n * \"_createdDate\": \"2021-03-29T20:51:21.216Z\",\n * \"_updatedDate\": \"2021-03-30T11:50:42.040Z\",\n * \"revision\": 6,\n * \"primaryInfo\": {\n * \"email\": \"celine.rousseau@example.com\",\n * \"phone\": \"0177-7912572\"\n * },\n * \"info\": {\n * \"name\": {\n * \"first\": \"Celine\",\n * \"last\": \"Rousseau\"\n * },\n * \"locale\": \"en\",\n * \"emails\": [\n * {\n * \"tag\": \"UNTAGGED\",\n * \"email\": \"celine.rousseau@example.com\",\n * \"primary\": true\n * }\n * ],\n * \"phones\": [\n * {\n * \"tag\": \"UNTAGGED\",\n * \"phone\": \"0177-7912572\",\n * \"primary\": true\n * }\n * ],\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"2451Rue des Cuirassiers\\n9502 Grosshöchstetten\\nSwitzerland\",\n * \"city\": \"Grosshöchstetten\",\n * \"subdivision\": \"CH-VD\",\n * \"country\": \"CH\",\n * \"postalCode\": \"9502\",\n * \"addressLine1\": \"2451Rue des Cuirassiers\"\n * },\n * \"tag\": \"SHIPPING\"\n * },\n * {\n * \"address\": {\n * \"formatted\": \"2451Rue des Cuirassiers\\n9502 Grosshöchstetten\\nSwitzerland\",\n * \"city\": \"Grosshöchstetten\",\n * \"subdivision\": \"CH-VD\",\n * \"country\": \"CH\",\n * \"postalCode\": \"9502\",\n * \"addressLine1\": \"2451Rue des Cuirassiers\"\n * },\n * \"tag\": \"BILLING\"\n * },\n * {\n * \"address\": {\n * \"formatted\": \"Israel\",\n * \"country\": \"IL\"\n * },\n * \"tag\": \"UNTAGGED\"\n * }\n * ],\n * \"labelKeys\": [\n * \"contacts.customers\"\n * ],\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Rousseau Celine\",\n * \"emailSubscriptions.deliverabilityStatus\": \"BOUNCED\",\n * \"ecom.lastPurchaseDate\": \"2021-03-29T21:00:35.835Z\",\n * \"members.membershipStatus\": \"APPROVED\",\n * \"ecom.numOfPurchases\": 2,\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"ecom.totalSpentAmount\": 27.5,\n * \"members.mobile\": false,\n * \"contacts.displayByFirstName\": \"Celine Rousseau\",\n * \"ecom.totalSpentCurrency\": \"ILS\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-29T20:58:47.548Z\",\n * \"activityType\": \"MEMBER_STATUS_CHANGED\"\n * },\n * \"source\": {\n * \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n * \"sourceType\": \"WIX_STORES\"\n * }\n * },\n * {\n * \"_id\": \"b508466c-dcd3-4284-917f-3ff678762940\",\n * \"_createdDate\": \"2021-03-29T17:19:43.786Z\",\n * \"_updatedDate\": \"2021-03-29T18:04:02.082Z\",\n * \"revision\": 3,\n * \"primaryInfo\": {\n * \"email\": \"zackary.sirko@example.com\",\n * \"phone\": \"796-685-0846\"\n * },\n * \"info\": {\n * \"name\": {\n * \"first\": \"Zackary\",\n * \"last\": \"Sirko\"\n * },\n * \"emails\": [\n * {\n * \"_id\": \"00a88829-c21c-46b9-ab28-aaaae7f2f057\",\n * \"tag\": \"UNTAGGED\",\n * \"email\": \"zackary.sirko@example.com\",\n * \"primary\": true\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"2f68e6c0-10b5-4c4c-b117-f2d7f8663475\",\n * \"tag\": \"UNTAGGED\",\n * \"phone\": \"796-685-0846\",\n * \"primary\": true\n * }\n * ],\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"8768 King St\\nCumberland, Z1D 6P8\\nCanada\",\n * \"city\": \"Cumberland\",\n * \"country\": \"CA\",\n * \"postalCode\": \"Z1D 6P8\",\n * \"addressLine1\": \"8768 King St\"\n * },\n * \"_id\": \"816f720d-f329-4774-90f7-1d5c75936e47\",\n * \"tag\": \"UNTAGGED\"\n * }\n * ],\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Sirko Zackary\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"members.membershipStatus\": \"APPROVED\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"members.mobile\": false,\n * \"emailSubscriptions.effectiveEmail\": \"zackary.sirko@example.com\",\n * \"contacts.displayByFirstName\": \"Zackary Sirko\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-29T17:19:44.747Z\",\n * \"activityType\": \"MEMBER_REGISTER\"\n * },\n * \"source\": {\n * \"sourceType\": \"ADMIN\"\n * }\n * },\n * {\n * \"_id\": \"73904dbd-94ca-4ac1-a593-ef0627673e59\",\n * \"_createdDate\": \"2021-03-29T13:17:19.169Z\",\n * \"_updatedDate\": \"2021-03-29T15:16:40.971Z\",\n * \"revision\": 5,\n * \"primaryInfo\": {\n * \"email\": \"ines.brunet@example.com\",\n * \"phone\": \"01-27-29-38-74\"\n * },\n * \"info\": {\n * \"name\": {\n * \"first\": \"Inès\",\n * \"last\": \"Brunet\"\n * },\n * \"profilePicture\": \"https://www.wix.com/_api/contacts/v4/media-gateway/redirect/JWE.eyJhbGciOiJBMTI4S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2Iiwia2lkIjoiUTBub2RfZ1gifQ.44GkOpjoCNjHRGpKesfyoDZEPxnmEGaqBw-6Vl_YZum8VLFKf274lQ.3K4URkUMNfHgdLs56Ub1Dg.bu3tcHR1VDqaRvcVU3dxlYIL5u0K2TDWYE9XVasxOq02r5FOeBzw1mZ_TGlOmYv0jIhffFXU7IhTUWzZIfGholGsjCVe5KRYzUyx4D2jQPh4sERYxLKluD6f3J6-yHEuhH_UWu9GiZynqRHD3SCsjpLbewnQDM0BxJdXnze0qGakJl44KhCdvRpEtUz9aboemu1WwEHc3sj5UQVHA78LDw.91QdN1ZuB6L7PyLppMCrcg\",\n * \"emails\": [\n * {\n * \"_id\": \"114a1f7f-18a6-4a90-b5a7-972e763337fb\",\n * \"tag\": \"WORK\",\n * \"email\": \"ines.brunet@example.com\",\n * \"primary\": true\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"6268e2b9-1cbf-486d-b986-10a08af53a8a\",\n * \"tag\": \"HOME\",\n * \"phone\": \"01-27-29-38-74\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"f8da8843-7e52-4010-9e40-d21821a1745f\",\n * \"tag\": \"MOBILE\",\n * \"phone\": \"06-48-73-26-70\",\n * \"primary\": false\n * }\n * ],\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"8416 E Sandy Lake Rd\\n69922, Ardennes\\nFrance\",\n * \"city\": \"Ardennes\",\n * \"country\": \"FR\",\n * \"postalCode\": \"69922\",\n * \"addressLine1\": \"8416 E Sandy Lake Rd\"\n * },\n * \"_id\": \"4fa3e416-8924-4125-8922-0db7fe960666\",\n * \"tag\": \"UNTAGGED\"\n * }\n * ],\n * \"labelKeys\": [\n * \"custom.marketing-your-business-on-social-media\",\n * \"contacts.contacted-me\"\n * ],\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Brunet Inès\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"SUBSCRIBED\",\n * \"emailSubscriptions.effectiveEmail\": \"ines.brunet@example.com\",\n * \"contacts.displayByFirstName\": \"Inès Brunet\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-29T13:17:19.166Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"source\": {\n * \"sourceType\": \"ADMIN\"\n * }\n * }\n * ]\n */"},{"title":"Query for a contact and then email the contact","description":"You can use `queryContacts()`\nto find a contact with specified details, and then extract the contact's ID.\nWith the contact ID, you can use [`emailContact()`](wix-crm-backend/emailcontact)\nto send a triggered email.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts, triggeredEmails } from 'wix-crm-backend';\n\nexport const sendEmailToContact = webMethod(Permissions.Anyone, async (emailToFind) => {\n let contactId;\n const queryResults = await contacts.queryContacts()\n .eq('info.emails.email', emailToFind)\n .find();\n const contactsWithEmail = queryResults.items;\n\n if (contactsWithEmail.length === 1) {\n console.log('Found 1 contact');\n contactId = contactsWithEmail[0]._id;\n } else if (contactsWithEmail.length > 1) {\n console.log('Found more than 1 contact');\n // Handle when more than one contact is found\n } else {\n console.log('No contacts found');\n // Handle when no contacts are found\n }\n\n const triggeredEmailTemplate = 'welcome_email';\n\n try {\n await triggeredEmails.emailContact(triggeredEmailTemplate, contactId);\n console.log('Email sent to contact');\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});"},{"title":"Get recently joined New York members, limited to return to 25 results","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const getRecentNewYorkMembers = webMethod(Permissions.Anyone, async () => {\n try {\n const queryResults = await contacts.queryContacts()\n .gt('_createdDate', new Date('2022-01-01T00:00:00.000Z'))\n .eq('info.addresses.city', 'New York')\n .eq('info.extendedFields.members.membershipStatus', 'APPROVED')\n .limit(25)\n .find();\n\n return queryResults;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Returns items:\n * [\n * {\n * \"_createdDate\": \"2022-02-01T13:13:50.963Z\",\n * \"_id\": \"f29baf24-943f-4402-b7cc-5658ed5f8867\",\n * \"info\": {\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"9267 Adams St\\nNew York, New York 10002\\nUnited States\",\n * \"city\": \"New York\",\n * \"subdivision\": \"US-NY\",\n * \"country\": \"US\",\n * \"postalCode\": \"10002\",\n * \"addressLine1\": \"9267 Adams St\"\n * },\n * \"_id\": \"3586b551-92ef-49cf-88f4-17790369afa3\",\n * \"tag\": \"UNTAGGED\"\n * }\n * ],\n * \"emails\": [\n * {\n * \"_id\": \"eb6e1d0a-a54f-4612-af60-3ad15894927f\",\n * \"tag\": \"UNTAGGED\",\n * \"email\": \"sergiop565@example.com\",\n * \"primary\": true\n * }\n * ],\n * \"extendedFields\": {\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"members.membershipStatus\": \"APPROVED\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"emailSubscriptions.effectiveEmail\": \"sergiop565@example.com\",\n * },\n * \"name\": {\n * \"first\": \"Sergio\",\n * \"last\": \"Patterson\"\n * },\n * \"phones\": [\n * {\n * \"_id\": \"b3fc65c7-1870-4458-a989-d6f9fdb97c86\",\n * \"tag\": \"UNTAGGED\",\n * \"phone\": \"(212)-665-2602\",\n * \"formattedPhone\": \"(212)-665-2602\",\n * \"primary\": true\n * }\n * ]\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2022-02-01T13:13:51.364Z\",\n * \"activityType\": \"MEMBER_REGISTER\"\n * },\n * \"primaryInfo\": {\n * \"email\": \"sergiop565@example.com\",\n * \"phone\": \"(212)-665-2602\"\n * },\n * \"revision\": 2,\n * \"source\": {\n * \"appId\": \"eb377299-86b4-4a86-a1b5-774a2d1d374b\",\n * \"sourceType\": \"WIX_SITE_MEMBERS\"\n * },\n * \"_updatedDate\": \"2022-02-03T13:13:41.263Z\"\n * },\n * {\n * \"_createdDate\": \"2022-02-01T13:24:27.733Z\",\n * \"_id\": \"315cb333-b8cd-4f03-a772-d3614dbcc282\",\n * \"info\": {\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"6489 E Sandy Lake Rd\\nNew York, 10011\\nUnited States\",\n * \"city\": \"New York\",\n * \"country\": \"US\",\n * \"postalCode\": \"10011\",\n * \"addressLine1\": \"6489 E Sandy Lake Rd\"\n * },\n * \"_id\": \"efd7e4e8-e515-41a4-ba85-4bcdf1449a51\",\n * \"tag\": \"UNTAGGED\"\n * }\n * ],\n * \"emails\": [\n * {\n * \"_id\": \"6a8b204a-dbbf-4834-98e9-139701f535ff\",\n * \"tag\": \"UNTAGGED\",\n * \"email\": \"megan.moreno@example.com\",\n * \"primary\": true\n * }\n * ],\n * \"extendedFields\": {\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"members.membershipStatus\": \"APPROVED\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"emailSubscriptions.effectiveEmail\": \"megan.moreno@example.com\",\n * },\n * \"name\": {\n * \"first\": \"Megan\",\n * \"last\": \"Moreno\"\n * },\n * \"phones\": [\n * {\n * \"_id\": \"21b2363e-5cc5-4071-b5ac-16697c4d8872\",\n * \"tag\": \"UNTAGGED\",\n * \"phone\": \"(266)-333-9487\",\n * \"formattedPhone\": \"(266)-333-9487\",\n * \"primary\": true\n * }\n * ]\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2022-02-01T13:24:28.139Z\",\n * \"activityType\": \"MEMBER_REGISTER\"\n * },\n * \"primaryInfo\": {\n * \"email\": \"megan.moreno@example.com\",\n * \"phone\": \"(266)-333-9487\"\n * },\n * \"revision\": 2,\n * \"source\": {\n * \"appId\": \"eb377299-86b4-4a86-a1b5-774a2d1d374b\",\n * \"sourceType\": \"WIX_SITE_MEMBERS\"\n * },\n * \"_updatedDate\": \"2022-02-03T13:10:30.174Z\"\n * }\n * ]\n */"}],"description":"Creates a query to retrieve a list of contacts.\r\n\r\nThe `queryContacts()` function builds a query to retrieve a list of contacts\r\nand returns a\r\n[`ContactsQueryBuilder`](wix-crm-backend/contacts/contacts-query-builder/introduction)\r\nobject.\r\n\r\nThe returned object contains the query definition,\r\nwhich is typically used to run the query using the\r\n[`find()`](wix-crm-backend/contacts/contacts-query-builder/find)\r\nfunction.\r\n\r\nYou can refine the query\r\nby chaining `ContactsQueryBuilder` functions onto the query.\r\n`ContactsQueryBuilder` functions enable you to sort, filter,\r\nand control the results `queryContacts()` returns.\r\n\r\n`queryContacts()` runs with these `ContactsQueryBuilder` defaults,\r\nwhich you can override:\r\n\r\n- [`skip(0)`](wix-crm-backend/contacts/contacts-query-builder/skip)\r\n- [`limit(50)`](wix-crm-backend/contacts/contacts-query-builder/limit)\r\n- [`descending(\"_createdDate\")`](wix-crm-backend/contacts/contacts-query-builder/descending)\r\n\r\nThe functions that are chained to `queryContacts()`\r\nare applied in the order they are called.\r\nFor example, if you apply `ascending('info.company')`\r\nand then `descending('info.name.last')`,\r\nthe results are sorted first by the company name, and then,\r\nif there are multiple results with the same company,\r\nthe items are sorted by last name.\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can query contacts.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`\r\n> in the [`find()`](wix-crm-backend/contacts/contacts-query-builder/find) function.\r\n\r\nFor property support for filters and sorting, see\r\n[Query contacts: Supported filters, sorting, and search](wix-crm-backend/contacts/sort,-filter,-and-search).","sdkErrors":[]},{"name":"queryExtendedFields","fqn":"Contacts.queryExtendedFields","slug":"query-extended-fields","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryBuilder","referenceFqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder","description":"A `ExtendedFieldsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Retrieve all extended fields","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryExtendedFieldsFunction = webMethod(Permissions.Anyone, async (options) => {\n try {\n const queryResults = contacts.queryExtendedFields().find(options);\n\n const items = queryResults.items;\n const firstItem = items[0];\n const pageSize = queryResults.pageSize;\n const hasNext = queryResults.hasNext();\n const hasPrev = queryResults.hasPrev();\n const length = queryResults.length;\n const query = queryResults.query;\n\n return items;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});\n\n/* Returns items:\n * [\n * {\n * \"_createdDate\": \"2021-03-30T12:41:13.000Z\",\n * \"_updatedDate\": \"2021-03-30T12:41:13.000Z\",\n * \"displayName\": \"Event we met at\",\n * \"key\": \"custom.event-we-met-at\",\n * \"dataType\": \"TEXT\",\n * \"namespace\": \"custom\",\n * \"fieldType\": \"USER_DEFINED\"\n * },\n * {\n * \"_createdDate\": \"2021-01-19T23:18:17.000Z\",\n * \"_updatedDate\": \"2021-01-19T23:18:17.000Z\",\n * \"displayName\": \"Last Contacted\",\n * \"key\": \"custom.last-contacted\",\n * \"dataType\": \"DATE\",\n * \"namespace\": \"custom\",\n * \"fieldType\": \"USER_DEFINED\"\n * },\n * {\n * \"_createdDate\": \"2021-01-17T18:42:31.000Z\",\n * \"_updatedDate\": \"2021-01-17T18:42:31.000Z\",\n * \"displayName\": \"Patronus\",\n * \"key\": \"custom.patronus\",\n * \"dataType\": \"TEXT\",\n * \"namespace\": \"custom\",\n * \"fieldType\": \"USER_DEFINED\"\n * },\n * {\n * \"displayName\": \"Display Name (start with first)\",\n * \"key\": \"contacts.displayByFirstName\",\n * \"description\": \"Display name starting with first name (read only)\",\n * \"dataType\": \"TEXT\",\n * \"namespace\": \"contacts\",\n * \"fieldType\": \"SYSTEM\"\n * },\n * {\n * \"displayName\": \"Display Name (start with last)\",\n * \"key\": \"contacts.displayByLastName\",\n * \"description\": \"Display name starting with last name (read only)\",\n * \"dataType\": \"TEXT\",\n * \"namespace\": \"contacts\",\n * \"fieldType\": \"SYSTEM\"\n * },\n * {\n * \"displayName\": \"VAT ID\",\n * \"key\": \"invoices.vatId\",\n * \"description\": \"Vat ID for Wix Invoices\",\n * \"dataType\": \"TEXT\",\n * \"namespace\": \"invoices\",\n * \"fieldType\": \"SYSTEM\"\n * },\n * {\n * \"displayName\": \"Membership Status\",\n * \"key\": \"members.membershipStatus\",\n * \"description\": \"APPROVED/DENIED/PENDING/INACTIVE (read only)\",\n * \"dataType\": \"TEXT\",\n * \"namespace\": \"members\",\n * \"fieldType\": \"SYSTEM\"\n * },\n * {\n * \"displayName\": \"Mobile flag\",\n * \"key\": \"members.mobile\",\n * \"description\": \"true/false\",\n * \"dataType\": \"TEXT\",\n * \"namespace\": \"members\",\n * \"fieldType\": \"SYSTEM\"\n * },\n * {\n * \"displayName\": \"# of Purchases\",\n * \"key\": \"ecom.numOfPurchases\",\n * \"description\": \"Wix Stores purchase count (read only)\",\n * \"dataType\": \"NUMBER\",\n * \"namespace\": \"ecom\",\n * \"fieldType\": \"SYSTEM\"\n * },\n * {\n * \"displayName\": \"Total Spent Amount\",\n * \"key\": \"ecom.totalSpentAmount\",\n * \"description\": \"Wix Stores aggregated spent amount (read only)\",\n * \"dataType\": \"NUMBER\",\n * \"namespace\": \"ecom\",\n * \"fieldType\": \"SYSTEM\"\n * },\n * {\n * \"displayName\": \"Total Spent Currency\",\n * \"key\": \"ecom.totalSpentCurrency\",\n * \"description\": \"Wix Stores currency code (read only)\",\n * \"dataType\": \"TEXT\",\n * \"namespace\": \"ecom\",\n * \"fieldType\": \"SYSTEM\"\n * },\n * {\n * \"displayName\": \"Last Purchase Date\",\n * \"key\": \"ecom.lastPurchaseDate\",\n * \"description\": \"Wix Stores last purchase date (read only)\",\n * \"dataType\": \"DATE\",\n * \"namespace\": \"ecom\",\n * \"fieldType\": \"SYSTEM\"\n * },\n * {\n * \"displayName\": \"Effective Subscription Status\",\n * \"key\": \"emailSubscriptions.subscriptionStatus\",\n * \"description\": \"SUBSCRIBED/UNSUBSCRIBED/NOT_SET/PENDING (read only)\",\n * \"dataType\": \"TEXT\",\n * \"namespace\": \"emailSubscriptions\",\n * \"fieldType\": \"SYSTEM\"\n * },\n * {\n * \"displayName\": \"Effective Deliverability Status\",\n * \"key\": \"emailSubscriptions.deliverabilityStatus\",\n * \"description\": \"VALID/BOUNCED/SPAM_COMPLAINT/INACTIVE (read only)\",\n * \"dataType\": \"TEXT\",\n * \"namespace\": \"emailSubscriptions\",\n * \"fieldType\": \"SYSTEM\"\n * },\n * {\n * \"displayName\": \"Effective Email\",\n * \"key\": \"emailSubscriptions.effectiveEmail\",\n * \"description\": \"Effective Email for subscription purposes (read only)\",\n * \"dataType\": \"TEXT\",\n * \"namespace\": \"emailSubscriptions\",\n * \"fieldType\": \"SYSTEM\"\n * }\n * ]\n */"}],"description":"Creates a query to retrieve a list of extended fields.\r\n\r\nThe `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an\r\n[`ExtendedFieldsQueryBuilder`](wix-crm-backend/contacts/extended-fields-query-builder/introduction)\r\nobject.\r\n\r\nThe returned object contains the query definition,\r\nwhich is used to run the query using the\r\n[`find()`](wix-crm-backend/contacts/extended-fields-query-builder/find)\r\nfunction.\r\n\r\nYou can refine the query\r\nby chaining `ExtendedFieldsQueryBuilder` functions onto the query.\r\n`ExtendedFieldsQueryBuilder` functions enable you to\r\ncontrol the results `queryExtendedFields()` returns.\r\n\r\n`queryExtendedFields()` runs with these `ExtendedFieldsQueryBuilder` defaults,\r\nwhich you can override:\r\n\r\n- [`skip(0)`](wix-crm-backend/contacts/extended-fields-query-builder/skip)\r\n- [`limit(50)`](wix-crm-backend/contacts/extended-fields-query-builder/limit)\r\n- [`descending(\"_createdDate\")`](wix-crm-backend/contacts/extended-fields-query-builder/descending)\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can query extended fields.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`\r\n> in the [`find()`](wix-crm-backend/contacts/extended-fields-query-builder/find) function.\r\n\r\n#### Supported Query Filters\r\n\r\nThe following `ExtendedFieldsQueryBuilder` filters\r\nare supported for `queryExtendedFields()`.\r\n\r\nFor a full description of the `ExtendedField` object, see\r\n[`ExtendedFieldsQueryResult`](wix-crm-backend/contacts/extended-fields-query-result/introduction) \r\n[`items`](wix-crm-backend/contacts/extended-fields-query-result/items).\r\n\r\n| Property | Supported Sorting |\r\n| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\r\n| `_createdDate` | [`ascending()`](wix-crm-backend/contacts/extended-fields-query-builder/ascending), [`descending()`](wix-crm-backend/contacts/extended-fields-query-builder/descending) |\r\n| `_updatedDate` | [`ascending()`](wix-crm-backend/contacts/extended-fields-query-builder/ascending), [`descending()`](wix-crm-backend/contacts/extended-fields-query-builder/descending) |\r\n| `displayName` | [`ascending()`](wix-crm-backend/contacts/extended-fields-query-builder/ascending), [`descending()`](wix-crm-backend/contacts/extended-fields-query-builder/descending) |","sdkErrors":[]},{"name":"queryLabels","fqn":"Contacts.queryLabels","slug":"query-labels","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LabelsQueryBuilder","referenceFqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder","description":"A `LabelsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Retrieve all labels","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryLabelsFunction = webMethod(Permissions.Anyone, async (options) => {\n try {\n\n const queryResults = await contacts.queryLabels()\n .find(options);\n\n const items = queryResults.items;\n const firstItem = items[0];\n const pageSize = queryResults.pageSize;\n const hasNext = queryResults.hasNext();\n const hasPrev = queryResults.hasPrev();\n const length = queryResults.length;\n const query = queryResults.query;\n\n return items;\n\n } catch (error) {\n\n console.error(error);\n // Handle the error\n\n }\n});\n\n/* Returns items:\n * [\n * {\n * \"_createdDate\": \"2021-03-30T12:42:06.000Z\",\n * \"_updatedDate\": \"2021-03-30T12:42:06.000Z\",\n * \"displayName\": \"New Lead\",\n * \"key\": \"custom.new-lead\",\n * \"namespace\": \"custom\",\n * \"labelType\": \"USER_DEFINED\"\n * },\n * {\n * \"_createdDate\": \"2021-03-29T13:17:29.000Z\",\n * \"_updatedDate\": \"2021-03-29T13:17:29.000Z\",\n * \"displayName\": \"Marketing Your Business on Social Media\",\n * \"key\": \"custom.marketing-your-business-on-social-media\",\n * \"namespace\": \"custom\",\n * \"labelType\": \"USER_DEFINED\"\n * },\n * {\n * \"_createdDate\": \"2021-01-20T12:49:09.000Z\",\n * \"_updatedDate\": \"2021-01-20T12:49:09.000Z\",\n * \"displayName\": \"Quick Win\",\n * \"key\": \"custom.quick-win\",\n * \"namespace\": \"custom\",\n * \"labelType\": \"USER_DEFINED\"\n * },\n * {\n * \"_createdDate\": \"2021-01-20T12:48:46.000Z\",\n * \"_updatedDate\": \"2021-01-20T12:48:46.000Z\",\n * \"displayName\": \"Stale Lead\",\n * \"key\": \"custom.stale-lead\",\n * \"namespace\": \"custom\",\n * \"labelType\": \"USER_DEFINED\"\n * },\n * {\n * \"_createdDate\": \"2021-01-20T06:55:58.000Z\",\n * \"_updatedDate\": \"2021-01-20T06:55:58.000Z\",\n * \"displayName\": \"White Glove Treatment\",\n * \"key\": \"custom.white-glove-treatment\",\n * \"namespace\": \"custom\",\n * \"labelType\": \"USER_DEFINED\"\n * },\n * {\n * \"_createdDate\": \"2021-01-20T06:55:47.000Z\",\n * \"_updatedDate\": \"2021-01-20T06:55:47.000Z\",\n * \"displayName\": \"At Risk\",\n * \"key\": \"custom.at-risk\",\n * \"namespace\": \"custom\",\n * \"labelType\": \"USER_DEFINED\"\n * },\n * {\n * \"_createdDate\": \"2021-01-20T00:31:41.000Z\",\n * \"_updatedDate\": \"2021-01-20T00:31:41.000Z\",\n * \"displayName\": \"Active Customer\",\n * \"key\": \"custom.active-customer\",\n * \"namespace\": \"custom\",\n * \"labelType\": \"USER_DEFINED\"\n * },\n * {\n * \"_createdDate\": \"2021-01-19T21:38:49.000Z\",\n * \"_updatedDate\": \"2021-01-20T19:07:54.000Z\",\n * \"displayName\": \"Incoming\",\n * \"key\": \"custom.incoming-leads\",\n * \"namespace\": \"custom\",\n * \"labelType\": \"USER_DEFINED\"\n * },\n * {\n * \"displayName\": \"Customers\",\n * \"key\": \"contacts.customers\",\n * \"namespace\": \"contacts\",\n * \"labelType\": \"SYSTEM\"\n * },\n * {\n * \"displayName\": \"Contacted Me\",\n * \"key\": \"contacts.contacted-me\",\n * \"namespace\": \"contacts\",\n * \"labelType\": \"SYSTEM\"\n * }\n * ]\n */"}],"description":"Creates a query to retrieve a list of labels.\r\n\r\nThe `queryLabels()` function builds a query to retrieve a list of labels and returns a\r\n[`LabelsQueryBuilder`](wix-crm-backend/contacts/labels-query-builder)\r\nobject.\r\n\r\nThe returned object contains the query definition,\r\nwhich is used to run the query using the\r\n[`find()`](wix-crm-backend/contacts/labels-query-builder/find)\r\nfunction.\r\n\r\nYou can refine the query\r\nby chaining `LabelsQueryBuilder` functions onto the query.\r\n`LabelsQueryBuilder` functions enable you to\r\ncontrol the results `queryLabels()` returns.\r\n\r\n`queryLabels()` runs with these `LabelsQueryBuilder` defaults,\r\nwhich you can override:\r\n\r\n- [`skip(0)`](wix-crm-backend/contacts/labels-query-builder/skip)\r\n- [`limit(50)`](wix-crm-backend/contacts/labels-query-builder/limit)\r\n- [`descending(\"_createdDate\")`](wix-crm-backend/contacts/labels-query-builder/descending)\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can query labels.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`\r\n> in the [`find()`](wix-crm-backend/contacts/labels-query-builder/find) function.\r\n\r\nFor property support for filters and sorting, see\r\n[Query labels: Supported filters and sorting](wix-crm-backend/contacts/sort,-filter,-and-search).","sdkErrors":[]},{"name":"renameExtendedField","fqn":"Contacts.renameExtendedField","slug":"rename-extended-field","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["key","displayName"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ExtendedField","referenceFqn":"Contacts.ExtendedField"},"description":"Fulfilled - Updated extended field."},"examples":[{"title":"Rename an extended field","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myRenameExtendedFieldFunction = webMethod(Permissions.Anyone, () => {\n const fieldKey = \"custom.event-venue\";\n const displayName = \"Event Location\";\n const options = {\n suppressAuth: false\n };\n\n return contacts.renameExtendedField(fieldKey, displayName, options)\n .then((renamedExtendedField) => {\n return renamedExtendedField;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* Promise resolves to:\n *\n * {\n * \"_createdDate\": \"2021-01-19T22:06:34Z\",\n * \"_updatedDate\": \"2021-01-20T18:54:14Z\"\n * \"namespace\": \"custom\",\n * \"key\": \"custom.event-venue\",\n * \"displayName\": \"Event Location\",\n * \"dataType\": \"TEXT\",\n * \"fieldType\": \"USER_DEFINED\",\n * }\n */"}],"actionParams":[{"name":"key","slug":"key","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Extended field ID.\r\n\r\nWhen accessing contact data,\r\nextended field data is available at `extendedFields[key]`.\r\nFor example, if the key is \"custom.notes\",\r\nthe value can be accessed at `extendedFields[\"custom.notes\"]`.\r\n\r\n`key` is generated when the extended field is created\r\nand cannot be modified, even if `displayName` changes."},{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Display name shown in the Contact List."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Renames an extended field.\r\n\r\nThe `renameExtendedField()` function returns a Promise\r\nthat resolves when the specified extended field's display name is changed.\r\n\r\n\r\n\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can rename extended fields.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"renameLabel","fqn":"Contacts.renameLabel","slug":"rename-label","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["key","displayName"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Label","referenceFqn":"Contacts.Label"},"description":"Fulfilled - Updated label."},"examples":[{"title":"Rename a label","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myRenameLabelFunction = webMethod(Permissions.Anyone, () => {\n const labelKey = \"custom.incoming-leads\";\n const displayName = \"Incoming\";\n const options = {\n suppressAuth: false\n };\n\n return contacts.renameLabel(labelKey, displayName, options)\n .then((renamedLabel) => {\n return renamedLabel;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* Promise resolves to:\n *\n * {\n * \"_createdDate\": \"2021-01-19T21:38:49Z\",\n * \"_updatedDate\": \"2021-01-20T19:07:54Z\"\n * \"namespace\": \"custom\",\n * \"key\": \"custom.incoming-leads\",\n * \"displayName\": \"Incoming\",\n * \"labelType\": \"USER_DEFINED\"\n * }\n */"}],"actionParams":[{"name":"key","slug":"key","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Label key.\r\n\r\n`key` is generated when the label is created\r\nand cannot be modified, even if `displayName` changes."},{"name":"displayName","slug":"display-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Label display name shown in the Dashboard."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Renames a label.\r\n\r\nThe `renameLabel()` function returns a Promise\r\nthat resolves when the specified label's display name is changed.\r\n\r\n\r\n\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can rename labels.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"unlabelContact","fqn":"Contacts.unlabelContact","slug":"unlabel-contact","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["contactId","labelKeys"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Contact","referenceFqn":"Contacts.Contact"},"description":"Fulfilled - Updated contact."},"examples":[{"title":"Unlabel a contact","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myUnlabelContactFunction = webMethod(Permissions.Anyone, () => {\n const contactId = \"bc0ae72b-3285-485b-b0ad-c32c769a4daf\";\n const labelKeys = [\n \"custom.at-risk\",\n \"custom.white-glove-treatment\"\n ];\n const options = {\n suppressAuth: false\n };\n\n return contacts.unlabelContact(contactId, labelKeys, options)\n .then((unlabeledContact) => {\n return unlabeledContact;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* Promise resolves to:\n * {\n * \"_id\": \"bc0ae72b-3285-485b-b0ad-c32c769a4daf\",\n * \"_createdDate\": \"2021-03-30T13:12:39.650Z\",\n * \"_updatedDate\": \"2021-04-07T21:03:39.481Z\",\n * \"revision\": 2,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Gene\",\n * \"last\": \"Lopez\"\n * },\n * \"birthdate\": \"1981-11-02\",\n * \"jobTitle\": \"Senior Staff Attorney\",\n * \"company\": \"Borer and Sons, Attorneys at Law\",\n * \"locale\": \"en-us\",\n * \"profilePicture\": \"https://randomuser.me/api/portraits/men/0.jpg\",\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"9834 Bollinger Rd\\nEl Cajon, WY 97766\\nUS\",\n * \"location\": {\n * \"latitude\": 84.1048,\n * \"longitude\": -116.8836\n * },\n * \"city\": \"El Cajon\",\n * \"subdivision\": \"US-WY\",\n * \"country\": \"US\",\n * \"postalCode\": \"97766\",\n * \"streetAddress\": {\n * \"name\": \"Bollinger Rd\",\n * \"number\": \"9834\",\n * \"apt\": \"\"\n * }\n * },\n * \"_id\": \"8532051f-91f2-42d9-9a97-9f2c39e64f7a\",\n * \"tag\": \"HOME\"\n * }\n * ],\n * \"emails\": [\n * {\n * \"_id\": \"5bdcce4a-37c2-46ed-b49c-d562c6e3c4ce\",\n * \"tag\": \"HOME\",\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"78e5f398-e148-448d-b490-7c0b7d2ab336\",\n * \"tag\": \"WORK\",\n * \"email\": \"gene.lopez@example.com\",\n * \"primary\": false\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"820e4640-ffe0-4980-a097-62a715e73135\",\n * \"tag\": \"MOBILE\",\n * \"countryCode\": \"US\",\n * \"phone\": \"(722)-138-3099\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"8506549e-e4f8-42f6-b6fc-9db155b582ef\",\n * \"tag\": \"HOME\",\n * \"countryCode\": \"US\",\n * \"phone\": \"(704)-454-1233\",\n * \"e164Phone\": \"+17044541233\",\n * \"primary\": false\n * }\n * ],\n * \"labelKeys\": [\n * \"contacts.contacted-me\",\n * \"custom.new-lead\"\n * ],\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Lopez Gene\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"custom.event-we-met-at\": \"LegalBigData\",\n * \"emailSubscriptions.effectiveEmail\": \"gene.lopez.at.home@example.com\",\n * \"contacts.displayByFirstName\": \"Gene Lopez\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-30T13:12:39.649Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"primaryInfo\": {\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"phone\": \"(722)-138-3099\"\n * },\n * \"source\": {\n * \"sourceType\": \"OTHER\"\n * }\n * }\n */"}],"actionParams":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the contact to remove labels from."},{"name":"labelKeys","slug":"label-keys","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of label keys to remove from the contact."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Removes labels from a contact.\r\n\r\n\r\n\r\n\r\nThe `unlabelContact()` function returns a Promise\r\nthat resolves when the specified labels are removed from the contact.\r\n\r\nIf a label is no longer needed\r\nand you want to remove it from all contacts,\r\nyou can delete it with\r\n[`deleteLabel()`](wix-crm-backend/contacts/delete-label).\r\n\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can unlabel contacts.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"updateContact","fqn":"Contacts.updateContact","slug":"update-contact","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["identifiers","contactInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Contact","referenceFqn":"Contacts.Contact"},"description":"Fulfilled - Updated contact."},"examples":[{"title":"Update a contact","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myUpdateContactFunction = webMethod(Permissions.Anyone, () => {\n const contactIdentifiers = {\n contactId: \"0677ef55-cf20-4f68-989a-f31d3649eb72\",\n revision: 6\n };\n const contactInfo = {\n name: {\n first: \"Annie\",\n last: \"New Name\"\n },\n extendedFields: {\n \"custom.event-we-met-at\": \"Cloud Computing MegaCon\"\n }\n };\n const options = {\n allowDuplicates: false,\n suppressAuth: false\n };\n\n return contacts.updateContact(contactIdentifiers, contactInfo, options)\n .then((updatedContact) => {\n return updatedContact;\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* Promise resolves to:\n * {\n * \"_id\": \"0677ef55-cf20-4f68-989a-f31d3649eb72\",\n * \"_createdDate\": \"2021-03-31T20:24:48.393Z\",\n * \"_updatedDate\": \"2021-04-07T20:37:48.588Z\",\n * \"revision\": 7,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Annie\",\n * \"last\": \"New Name\"\n * },\n * \"extendedFields\": {\n * \"custom.event-we-met-at\": \"Cloud Computing MegaCon\",\n * \"contacts.displayByFirstName\": \"Annie New Name\",\n * \"contacts.displayByLastName\": \"New Name Annie\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-31T20:24:48.393Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"source\": {\n * \"appId\": \"manual\",\n * \"sourceType\": \"ADMIN\"\n * }\n * }\n */"},{"title":"Get a contact's latest revision number, then update","description":"The page code passes a contact ID and updated contact information\nto the backend `overwriteContactInfo()` function.\n`overwriteContactInfo()` then retrieves the contact,\nextracts the revision number, and passes it to `contacts.updateContact()`.\nThis ensures that the contact is always updated\nwithout needing to specify the revision.\n\nThis can be used when it's not important that some contact information could be overwritten.","content":"/*******************************\n * Backend code - contacts.web.js *\n *******************************/\n\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const overwriteContactInfo = webMethod(Permissions.Anyone, async (contactId, updatedContactInfo) => {\n\n // Get the contact's last revision number\n const myContact = await contacts.getContact(contactId);\n const contactIdentifiers = {\n contactId: contactId,\n revision: myContact.revision\n };\n const options = {\n allowDuplicates: false,\n suppressAuth: false\n };\n\n return await contacts.updateContact(contactIdentifiers, updatedContactInfo, options);\n});\n\n/*************\n * Page code *\n *************/\n\nimport { overwriteContactInfo } from 'backend/contacts.web';\n\n// ...\n\nconst contactId = \"0677ef55-cf20-4f68-989a-f31d3649eb72\";\n\nconst updatedContactInfo = {\n name: {\n first: \"Annie\",\n last: \"New Name\"\n }\n};\n\noverwriteContactInfo(contactId, updatedContactInfo)\n .then((updatedContact) => {\n return updatedContact;\n })\n .catch((error) => {\n console.error(error);\n });\n\n/* Updated contact resolves to:\n * {\n * \"_id\": \"0677ef55-cf20-4f68-989a-f31d3649eb72\",\n * \"_createdDate\": \"2021-03-31T20:24:48.393Z\",\n * \"_updatedDate\": \"2021-03-31T20:29:14.519Z\",\n * \"revision\": 4,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Annie\",\n * \"last\": \"New Name\"\n * },\n * \"extendedFields\": {\n * \"contacts.displayByFirstName\": \"Annie New Name\",\n * \"contacts.displayByLastName\": \"New Name Annie\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-31T20:24:48.393Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"source\": {\n * \"appId\": \"manual\",\n * \"sourceType\": \"ADMIN\"\n * }\n * }\n */\n"}],"actionParams":[{"name":"identifiers","slug":"identifiers","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Identifiers","referenceFqn":"Contacts.Identifiers"},"description":"Contact ID and revision number."},{"name":"contactInfo","slug":"contact-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactInfo","referenceFqn":"Contacts.ContactInfo"},"description":"Contact info."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Options","referenceFqn":"Contacts.Options"},"description":"Contact update options."}],"description":"Updates a contact's properties.\r\n\r\n\r\n\r\n\r\nThe `updateContact()` function returns a Promise that resolves\r\nwhen the specified contact's information is updated.\r\n\r\n> **Note:**\r\n> This function replaces the deprecated\r\n> `wixCrmBackend.updateContact()`.\r\n> The deprecated function will continue to work, but it will not receive updates.\r\n> To keep any existing code compatible with future changes, see the\r\n> [migration instructions](https://dev.wix.com/docs/velo/api-reference/wix-crm-backend/update-contact).\r\n\r\n\r\nEach time the contact is updated,\r\n`revision` increments by 1.\r\nThe existing `revision` must be included when updating the contact.\r\nThis ensures you're working with the latest contact information,\r\nand it prevents unintended overwrites.\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can update contacts.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]}],"webhooks":[],"articles":[{"content":"# Introduction\nWhen a new visitor first shares some of their contact information with your site,\nthey're added to your\n[Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).\nOnce that happens, their details are available through the Contacts API.\n\nSome examples of how a person can become a contact are:\n\n- A site visitor fills in a form with their contact details.\n- A site visitor signs up as a member of the site.\n- A site collaborator\n [imports a contact](https://support.wix.com/en/article/importing-contacts-by-uploading-a-csv-file-1066522) or\n [adds a contact manually](https://support.wix.com/en/article/manually-adding-contacts).\n- A 3rd-party app\n [creates a contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/create-contact)\n with the Contacts API.\n\nLearn more about how you can\n[manage your contact list](https://support.wix.com/en/article/about-your-contact-list).\n\nWith the Contacts APIs, you can:\n\n- Manage site contacts.\n- Manage contact labels.\n- Manage extended field definitions.\n\nTo use the Contacts API,\nimport `{ contacts }` from wix-crm-backend:\n\n```js\nimport { contacts } from 'wix-crm-backend';\n```\n\n## Before you begin\n\nIt's important to note this point before coding:\n\nIf a contact is also a site member or site contributor,\nthe contact cannot be deleted.\nThe related site member or site contributor\nmust first be deleted,\nand then the contact can also be deleted.\n\n## Terminology\n\n- **Extended fields**: Additional properties that store additional contact information.\n A contact's extended field data is available\n in the contact object under `info.extendedFields`.\n Extended field definitions can be created and managed with\n the extended field functions such as\n [`findOrCreateExtendedField()`](https://dev.wix.com/docs/velo/api-reference/wix-crm-backend/contacts/find-or-create-extended-field).\n\n There are 2 types of extended fields:\n\n - **System fields**: Extended fields added by Wix apps.\n System fields often enrich contacts with data from Wix apps,\n such as Wix Stores or Wix Members.\n System fields cannot be renamed and are typically read-only.\n - **Custom fields**: Extended fields added by site collaborators or 3rd-party apps.\n Custom fields can be renamed,\n and their data can be written by any site collaborators or 3rd-party app.\n\n- **Labels**: Tags that help site contributors categorize and organize their contacts.\n Labels can be system-defined or user-defined.\n You can manage a site's labels with\n the label functions such as\n [`findOrCreateLabel()`](https://dev.wix.com/docs/velo/api-reference/wix-crm-backend/contacts/find-or-create-label).\n A contact's assigned labels are available\n in the contact object under `info.labelKeys`.","displayName":"Introduction","slugifyName":"introduction"},{"content":"# About Extended Fields\n\nBasic contact information is stored in the contact's default properties.\nThis includes information such as\ncontact name, company, phone numbers, addresses, and email addresses.\nAdditional properties are stored in extended fields.\n\nThere are 2 types of extended fields:\n\n- **System fields** are added by Wix apps.\n They often enrich your contacts with data from Wix products,\n such as Wix Bookings or Wix Stores.\n System fields cannot be renamed.\n- **Custom fields** can be added by site contributors or 3rd-party apps.\n Custom fields can be renamed,\n and their data can be written by site contributors and 3rd-party apps.\n\nWhen you create, update, or retrieve contacts,\nyou'll find extended field data in the contact object under `info.extendedFields`.\nMost system fields are read-only, while all custom fields can be written to.\n","displayName":"About Extended Fields","slugifyName":"about-extended-fields"},{"content":"# About Labels\n\nLabels allow site collaborators to segment contacts in their Contact List.\nContact labels are useful for targeting specific audiences\nfor email campaigns or bulk actions.\n\nFor more information on how labels are used,\nsee [Creating Contact Labels](https://support.wix.com/en/article/creating-contact-labels).\n","displayName":"About Labels","slugifyName":"about-labels"},{"content":"# Last Activity Types\n\nWhen a contact interacts with your site,\nthe interaction is captured in `lastActivity` in the contact object.\nThe table below shows the possible `activityType` values\nand describes the interactions each activity type represents:\n\n| Activity Type | Description |\n|---|---|\n| `GENERAL` | Visited the site. |\n| `CONTACT_CREATED` | Became a new contact. |\n| `MEMBER_LOGIN` | Logged in. |\n| `MEMBER_REGISTER` | Requested site membership. |\n| `MEMBER_STATUS_CHANGED` | Was approved, blocked, or unblocked. |\n| `FORM_SUBMITTED` | Submitted a form. |\n| `INBOX_FORM_SUBMITTED` | Started a chat. |\n| `INBOX_PAYMENT_REQUEST_PAID` | Paid a payment request. |\n| `INBOX_MESSAGE_TO_CUSTOMER` | Received a message from a site contributor. |\n| `INBOX_MESSAGE_FROM_CUSTOMER` | Sent a new message to the site. |\n| `NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED` | Subscribed to a site newsletter. |\n| `NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE` | Unsubscribed from a site newsletter. |\n| `ECOM_PURCHASE` | Made a Wix Stores purchase. |\n| `ECOM_CART_ABANDON` | Abandoned their shopping cart. |\n| `ECOM_CHECKOUT_BUYER` | Checked out shopping cart and submitted buyer info (but didn’t complete purchase yet). |\n| `BOOKINGS_APPOINTMENT` | Booked an appointment. |\n| `HOTELS_RESERVATION` | Made a Wix Hotels reservation. |\n| `HOTELS_PURCHASE` | Paid for a Wix Hotels reservation. |\n| `HOTELS_CONFIRMATION` | Confirmed a Wix Hotels reservation. |\n| `HOTELS_CANCEL` | Canceled a Wix Hotels reservation. |\n| `VIDEO_PURCHASE` | Purchased a video. |\n| `VIDEO_RENT` | Rented a video. |\n| `CASHIER_BUTTON_PURCHASE` | Made a purchase with a pay button. |\n| `ARENA_NEW_LEAD` | Became a new Wix Marketplace lead. |\n| `EVENTS_RSVP` | Responded that they're attending an event. |\n| `INVOICE_PAY` | Paid an invoice. |\n| `INVOICE_OVERDUE` | Contact's invoice is now overdue. |\n| `PRICE_QUOTE_ACCEPT` | Accepted a price quote. |\n| `PRICE_QUOTE_EXPIRE` | Contact’s price quote has expired. |\n| `RESTAURANTS_ORDER` | Ordered food with Wix Restaurants. |\n| `RESTAURANTS_RESERVATION` | Made a Wix Restaurants reservation. |\n| `SHOUTOUT_OPEN` | Opened an email from the site. |\n| `SHOUTOUT_CLICK` | Clicked a link in an email from the site. |\n| `CONTACT_MERGED` | Merged with another contact. |\n","displayName":"Last Activity Types","slugifyName":"last-activity-types"},{"content":"# Contacts: Supported Filters, Sorting, and Search\n\nThis article covers field support for filtering, sorting, and searching\nin the Contacts API, the Labels API, and the Extended Fields API.\n\n## Query contacts: Supported filters, sorting, and search\n\nThe available options when calling \n[`queryContacts()`](wix-crm-backend/contacts/query-contacts)\nhave been divided into these 3 sections:\n\n- [Contact properties](#contact-properties-supported-filters,-sorting,-and-search):\n Covers querying the base set of contact properties,\n such as contact ID, name, emails, and labels.\n- [System fields](#system-fields-supported-filters,-sorting,-and-search):\n Covers querying system fields inside the `info.extendedFields` object.\n- [Custom fields](#custom-fields-supported-filters,-sorting,-and-search):\n Covers querying custom fields inside the `info.extendedFields` object.\n\nFor information on the difference between system fields and custom fields,\nsee [Terminology](contacts/introduction#terminology).\n\n### Contact properties: Supported filters, sorting, and search\n\nThe table below shows field support for filters, sorting,\nand free-text searching\nfor the base set of contact properties.\nIt doesn't include extended fields (those are covered in the sections below).\n\nFor a full description of the `Contact` object, see\n[`ContactsQueryResult`](wix-crm-backend/contacts/contacts-query-result) >\n[`items`](wix-crm-backend/contacts/contacts-query-result/items).\n\n| Property | Supported Filters & Sorting |\n| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_id` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some) |\n| `_createdDate` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`gt()`](contacts/contacts-query-builder/gt), [`lt()`](contacts/contacts-query-builder/lt), [`ge()`](contacts/contacts-query-builder/ge), [`le()`](contacts/contacts-query-builder/le), [`between()`](contacts/contacts-query-builder/between), [`ascending()`](contacts/contacts-query-builder/ascending), [`descending()`](contacts/contacts-query-builder/descending) |\n| `_updatedDate` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`gt()`](contacts/contacts-query-builder/gt), [`lt()`](contacts/contacts-query-builder/lt), [`ge()`](contacts/contacts-query-builder/ge), [`le()`](contacts/contacts-query-builder/le), [`between()`](contacts/contacts-query-builder/between) |\n| `lastActivity.activityDate` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`gt()`](contacts/contacts-query-builder/gt), [`lt()`](contacts/contacts-query-builder/lt), [`ge()`](contacts/contacts-query-builder/ge), [`le()`](contacts/contacts-query-builder/le), [`between()`](contacts/contacts-query-builder/between), [`ascending()`](contacts/contacts-query-builder/ascending), [`descending()`](contacts/contacts-query-builder/descending) |\n| `primaryInfo.email` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some), [`startsWith()`](contacts/contacts-query-builder/starts-with), [`ascending()`](contacts/contacts-query-builder/ascending), [`descending()`](contacts/contacts-query-builder/descending) |\n| `primaryInfo.phone` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some), [`startsWith()`](contacts/contacts-query-builder/starts-with) |\n| `info.name.first` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some), [`startsWith()`](contacts/contacts-query-builder/starts-with), [`ascending()`](contacts/contacts-query-builder/ascending), [`descending()`](contacts/contacts-query-builder/descending) |\n| `info.name.last` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some), [`startsWith()`](contacts/contacts-query-builder/starts-with), [`ascending()`](contacts/contacts-query-builder/ascending), [`descending()`](contacts/contacts-query-builder/descending) |\n| `info.emails.email` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some), [`startsWith()`](contacts/contacts-query-builder/starts-with) |\n| `info.phones.phone` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some), [`startsWith()`](contacts/contacts-query-builder/starts-with) |\n| `info.addresses.street` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some), [`startsWith()`](contacts/contacts-query-builder/starts-with) |\n| `info.addresses.city` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some), [`startsWith()`](contacts/contacts-query-builder/starts-with) |\n| `info.addresses.subdivision` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some), |\n| `info.addresses.country` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some), |\n| `info.company` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some), [`startsWith()`](contacts/contacts-query-builder/starts-with), [`ascending()`](contacts/contacts-query-builder/ascending), [`descending()`](contacts/contacts-query-builder/descending) |\n| `info.jobTitle` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some), [`startsWith()`](contacts/contacts-query-builder/starts-with), [`ascending()`](contacts/contacts-query-builder/ascending), [`descending()`](contacts/contacts-query-builder/descending) |\n| `info.birthdate` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`gt()`](contacts/contacts-query-builder/gt), [`lt()`](contacts/contacts-query-builder/lt), [`ge()`](contacts/contacts-query-builder/ge), [`le()`](contacts/contacts-query-builder/le), [`between()`](contacts/contacts-query-builder/between), [`ascending()`](contacts/contacts-query-builder/ascending), [`descending()`](contacts/contacts-query-builder/descending) |\n| `info.locale` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some), |\n| `info.labelKeys` | [`hasSome()`](contacts/contacts-query-builder/has-some), [`hasAll()`](contacts/contacts-query-builder/has-all) |\n\n### System fields: Supported filters, sorting, and search\n\nThe table below shows field support for filters, sorting,\nand free-text searching\nfor the Wix-defined\n[extended fields](wix-crm-backend/contacts/introduction#about-extended-fields)\n(also known as system fields).\n\n> **Note:**\n> When working directly with the `Contact` object in your code,\n> data in extended fields must be accessed\n> using bracket notation, like this:\n> `info.extendedFields['{key}']`.\n> However, when querying or sorting,\n> extended field names are flattened with dot notation, like this:\n> `ascending('info.extendedFields.{key}')`.\n\n| Extended Field | Supported Filters & Sorting | Supported Values |\n| ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |\n| `info.extendedFields.emailSubscriptions.deliverabilityStatus` | [`eq()`](contacts/contacts-query-builder/eq),[`ne()`](contacts/contacts-query-builder/ne),[`hasSome()`](contacts/contacts-query-builder/has-some) | `\"VALID\"`, `\"BOUNCED\"`, `\"SPAM_COMPLAINT\"`, `\"NOT_SET\"`, `\"INACTIVE\"`. |\n| `info.extendedFields.emailSubscriptions.effectiveEmail` | [`ascending()`](contacts/contacts-query-builder/ascending), [`descending()`](contacts/contacts-query-builder/descending) | |\n| `info.extendedFields.emailSubscriptions.subscriptionStatus` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some) | `\"SUBSCRIBED\"`, `\"UNSUBSCRIBED\"`, `\"NOT_SET\"`, `\"PENDING\"`. |\n| `info.extendedFields.members.membershipStatus` | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some) | `\"APPROVED\"`, `\"DENIED\"`, `\"PENDING\"`, `\"INACTIVE\"`. |\n\n### Custom fields: Supported filters, sorting, and search\n\nExtended fields that are created by 3rd-party apps or site contributors\nare known as _custom fields_.\nYou can add, remove, and change custom field names from the\n[Contact List](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts)\nin the Dashboard.\n\nThe table below shows field support for filters, sorting,\nand free-text searching for custom fields.\n\n> **Note:**\n> When querying or sorting,\n> extended field names are flattened to a dot-separated string, like this:\n> `'info.extendedFields.{key}'`.\n> For example, to query the `custom.new-customer` extended field,\n> use this flattened field name:\n> `'info.extendedFields.custom.new-customer'`.\n\n| Data Type/Format | Supported Filters & Sorting |\n| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| String | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`hasSome()`](contacts/contacts-query-builder/has-some), [`startsWith()`](contacts/contacts-query-builder/starts-with), [`ascending()`](contacts/contacts-query-builder/ascending), [`descending()`](contacts/contacts-query-builder/descending) |\n| Number | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`gt()`](contacts/contacts-query-builder/gt), [`lt()`](contacts/contacts-query-builder/lt), [`ge()`](contacts/contacts-query-builder/ge), [`le()`](contacts/contacts-query-builder/le), [`between()`](contacts/contacts-query-builder/between), [`ascending()`](contacts/contacts-query-builder/ascending), [`descending()`](contacts/contacts-query-builder/descending) |\n| Date string in `YYYY-MM-DD` format | [`eq()`](contacts/contacts-query-builder/eq), [`ne()`](contacts/contacts-query-builder/ne), [`gt()`](contacts/contacts-query-builder/gt), [`lt()`](contacts/contacts-query-builder/lt), [`ge()`](contacts/contacts-query-builder/ge), [`le()`](contacts/contacts-query-builder/le), [`between()`](contacts/contacts-query-builder/between), [`ascending()`](contacts/contacts-query-builder/ascending), [`descending()`](contacts/contacts-query-builder/descending) |\n\n## Query labels: Supported filters and sorting\n\nThis section covers the available options when calling\n[`queryLabels()`](wix-crm-backend/contacts/query-labels).\n\nThe table below shows field support for filters and sorting\nfor the label object.\n\nFor a full description of the `Label` object, see\n[`LabelsQueryResult`](wix-crm-backend/contacts/labels-query-result) >\n[`items`](wix-crm-backend/contacts/labels-query-result/items).\n\n| Property | Supported Sorting |\n| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_createdDate` | [`ascending()`](wix-crm-backend/contacts/labels-query-builder/ascending), [`descending()`](wix-crm-backend/contacts/labels-query-builder/descending) |\n| `_updatedDate` | [`ascending()`](wix-crm-backend/contacts/labels-query-builder/ascending), [`descending()`](wix-crm-backend/contacts/labels-query-builder/descending) |\n| `displayName` | [`ascending()`](wix-crm-backend/contacts/labels-query-builder/ascending), [`descending()`](wix-crm-backend/contacts/labels-query-builder/descending) |\n\n## Query extended fields: Supported filters and sorting\n\nThis section covers the available options when calling\n[`queryExtendedFields()`](wix-crm-backend/contacts/query-extended-fields).\n\nThe table below shows field support for filters and sorting\nfor the extended field object.\n\nFor a full description of the `ExtendedField` object, see\n[`ExtendedFieldsQueryResult`](wix-crm-backend/contacts/extended-fields-query-result) >\n[`items`](wix-crm-backend/contacts/extended-fields-query-result/items).\n\n| Property | Supported Sorting |\n| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `_createdDate` | [`ascending()`](wix-crm-backend/contacts/extended-fields-query-builder/ascending), [`descending()`](wix-crm-backend/contacts/extended-fields-query-builder/descending) |\n| `_updatedDate` | [`ascending()`](wix-crm-backend/contacts/extended-fields-query-builder/ascending), [`descending()`](wix-crm-backend/contacts/extended-fields-query-builder/descending) |\n| `displayName` | [`ascending()`](wix-crm-backend/contacts/extended-fields-query-builder/ascending), [`descending()`](wix-crm-backend/contacts/extended-fields-query-builder/descending) |\n","displayName":"Sort, Filter, and Search","slugifyName":"sort-filter-and-search"}],"namespaces":[{"name":"ContactsQueryBuilder","slug":"contacts-query-builder","fqn":"Contacts.ContactsQueryBuilder","standaloneTypes":[],"metadata":{},"actions":[{"name":"and","fqn":"Contacts.ContactsQueryBuilder.and","slug":"and","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add an `and` filter to a query","content":"const newQuery = query1.and(query2);"},{"title":"Create a compound query, add an `and` filter, and run it","description":"The first query, `subscriptionStatusQuery`, returns results\nwhere the contact's subscription status is either `\"NOT_SET\"` or `\"PENDING\"`.\nThe second query, `freshnessQuery` returns results\nwhere the contact was last updated before March 1, 2021,\nor where the contact is labeled as a stale lead.\n\nThe final query, `statusAndFreshnessQuery`, combines the first 2 queries with an `and` filter,\nand returns contacts that satisfy both queries.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n const subscriptionStatusQuery = contacts.queryContacts()\n .eq(\"info.extendedFields.emailSubscriptions.subscriptionStatus\", \"NOT_SET\")\n .or(\n contacts.queryContacts()\n .eq(\"info.extendedFields.emailSubscriptions.subscriptionStatus\", \"PENDING\")\n );\n\n const freshnessQuery = contacts.queryContacts()\n .lt(\"_updatedDate\", \"2021-03-01T00:00:00.000Z\")\n .or(\n contacts.queryContacts()\n .hasSome(\"info.labelKeys\", [\"custom.stale-lead\"])\n );\n\n const statusAndFreshnessQuery = subscriptionStatusQuery.and(freshnessQuery);\n\n return statusAndFreshnessQuery.find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder"},"description":"A query to add to the initial query as an `and` condition."}],"description":"Adds an `and` condition to the query.\r\n\r\nThe `and()` function adds an `and` condition to a `ContactsQueryBuilder`.\r\nA query with an `and` returns all the items that match the query\r\nas defined up to the `and` function and also match the query or\r\nfilter passed to the `and` function.\r\n\r\nNote that when chaining multiple `ContactsQueryBuilder` functions to a query an `and` condition is assumed.\r\nIn such cases, you do not need to add a call to the `and()` function.\r\nFor example, this query returns results where subscription status is not set **and**\r\nthe contact was created after March 1, 2021.\r\n\r\n```javascript\r\ncontacts.queryContacts()\r\n.eq(\"info.extendedFields.emailSubscriptions.subscriptionStatus\", \"NOT_SET\")\r\n.gt(\"_createdDate\", \"2021-03-01T00:00:00.000Z\");\r\n```\r\n\r\nThe `and()` function is needed when performing compound queries. For\r\nexample, the final query in this set of queries returns results where subscription status\r\nis either not set or pending **and** creation date is earlier than than March 1, 2021 or\r\nthe contact is labeled as a stale lead.\r\n\r\n```javascript\r\nconst subscriptionStatusQuery = contacts.queryContacts()\r\n.eq(\"info.extendedFields.emailSubscriptions.subscriptionStatus\", \"NOT_SET\")\r\n.or(\r\n contacts.queryContacts()\r\n .eq(\"info.extendedFields.emailSubscriptions.subscriptionStatus\", \"PENDING\")\r\n);\r\n\r\nconst freshnessQuery = contacts.queryContacts()\r\n.lt(\"_updatedDate\", \"2021-03-01T00:00:00.000Z\")\r\n.or(\r\n contacts.queryContacts()\r\n .hasSome(\"info.labelKeys\", [\"custom.stale-lead\"])\r\n);\r\n\r\nconst statusAndFreshnessQuery = subscriptionStatusQuery.and(freshnessQuery);\r\n```\r\n\r\nThe `and()` function is designed to work with 2 or more queries or filters.\r\nIf you use it on its own, it will return all the items that meet the query criteria.","sdkErrors":[]},{"name":"ascending","fqn":"Contacts.ContactsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add an `ascending` sort to a query","content":"const query = contacts.queryContacts().ascending(\"_createdDate\");"},{"title":"Create a query, add an `ascending` sort, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n\n return contacts.queryContacts()\n .ascending(\"info.name.last\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n\r\n- `_createdDate`\r\n- `lastActivity.activityDate`\r\n- `primaryInfo.email`\r\n- `info.name.first`\r\n- `info.name.last`\r\n- `info.company`\r\n- `info.jobTitle`\r\n- `info.birthdate`"}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `ContactsQueryBuilder` to sort in ascending order of\r\nthe specified properties. If you specify more than one property,\r\n`ascending()` sorts the results in ascending order by each property in the\r\norder they are listed.\r\n\r\nYou can sort the following types:\r\n\r\n+ Number: Sorts numerically.\r\n+ Date: Sorts by date and time.\r\n+ String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\nIf a property contains a number as a String, that value will be sorted\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified sort property are ranked lowest.","sdkErrors":[]},{"name":"between","fqn":"Contacts.ContactsQueryBuilder.between","slug":"between","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","rangeStart","rangeEnd"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add a `between` filter to a query","content":"const query = contacts.queryContacts().between(\"_createdDate\", \"2020-07-01\", \"2020-12-31\");"},{"title":"Create a query, add a `between` filter, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryContacts()\n .between(\"lastActivity.activityDate\", \"2021-01-01T00:00:00.000\", \"2021-01-31T11:59:59.000\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared to `rangeStart` and `rangeEnd`.\r\n\r\nSupported properties:\r\n\r\n- `_createdDate`\r\n- `_updatedDate`\r\n- `lastActivity.activityDate`\r\n- `info.birthdate`"},{"name":"rangeStart","slug":"range-start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."},{"name":"rangeEnd","slug":"range-end","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is within a specified range.\r\n\r\nThe `between()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property is greater than or equal\r\nto `rangeStart` and less than `rangeEnd`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically, so\r\n+ `\"A\"` and `\"M\"` are between `\"A\"` and `\"Z\"`, but `\"a\"`, `\"m\"`, `\"z\"` and `\"Z\"` are not.\r\n+ `\"A\"`, `\"M\"`, `\"Z\"`, and `\"a\"` are between `\"A\"` and `\"z\"`, but `\"z\"` is not.","sdkErrors":[]},{"name":"descending","fqn":"Contacts.ContactsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add a `descending` sort to a query","content":"const query = contacts.queryContacts().descending(\"_createdDate\");"},{"title":"Create a query, add a `descending` sort, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n\n return contacts.queryContacts()\n .descending(\"info.name.last\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n\r\n- `_createdDate`\r\n- `lastActivity.activityDate`\r\n- `primaryInfo.email`\r\n- `info.name.first`\r\n- `info.name.last`\r\n- `info.company`\r\n- `info.jobTitle`\r\n- `info.birthdate`"}],"description":"Adds a sort to a query, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `ContactsQueryBuilder` to sort in descending order of\r\nthe specified properties. If you specify more than one property,\r\n`descending()` sorts the results in descending order by each property in the\r\norder they are listed.\r\n\r\nYou can sort the following types:\r\n\r\n+ Number: Sorts numerically.\r\n+ Date: Sorts by date and time.\r\n+ String: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\r\n\r\nIf a property contains a number as a String, that value will be sorted\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified sort property are ranked lowest.","sdkErrors":[]},{"name":"eq","fqn":"Contacts.ContactsQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add an `eq` filter to a query","content":"const query = contacts.queryContacts().eq(\"info.company\", \"Wix\");"},{"title":"Create a query, add an `eq` filter, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryContacts()\n .eq(\"info.addresses.country\", \"GB\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\nSupported properties:\r\n\r\n- `\"_id\"`\r\n- `\"_createdDate\"`\r\n- `\"_updatedDate\"`\r\n- `\"lastActivity.activityDate\"`\r\n- `\"primaryInfo.email\"`\r\n- `\"primaryInfo.phone\"`\r\n- `\"info.name.first\"`\r\n- `\"info.name.last\"`\r\n- `\"info.emails.email\"`\r\n- `\"info.phones.phone\"`\r\n- `\"info.addresses.street\"`\r\n- `\"info.addresses.city\"`\r\n- `\"info.addresses.subdivision\"`\r\n- `\"info.addresses.country\"`\r\n- `\"info.company\"`\r\n- `\"info.jobTitle\"`\r\n- `\"info.birthdate\"`\r\n- `\"info.locale\"`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value equals the specified value.\r\n\r\nThe `eq()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property equals the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nMatching strings with `eq()` is case sensitive in most instances, so `\"text\"` is not equal to `\"Text\"`. \r\nOne exception is email fields, which are case insensitive when matching with `eq()`.\r\n\r\nIf the value of the `propertyName` property is an Array, `eq()` includes items\r\nin which any of the elements of the Array match the specified `value`.","sdkErrors":[]},{"name":"find","fqn":"Contacts.ContactsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ContactsQueryResult","referenceFqn":"Contacts.ContactsQueryResult.ContactsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/contacts-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `ContactsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"examples":[{"title":"Run a query with no filters","content":"const queryResults = contacts.queryContacts().find();"},{"title":"Perform a `find` on a query","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n\n return contacts.queryContacts()\n .find({\n suppressAuth: false\n })\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });\n\n});"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Returns the items that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\nby the query and some information about the results. The Promise is\r\nrejected if `find()` is called with incorrect permissions or if any of the\r\nfunctions used to refine the query are invalid.\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can query contacts.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"ge","fqn":"Contacts.ContactsQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add a `ge` filter to a query","content":"const query = contacts.queryContacts().ge(\"_createdDate\", \"2021-03-01\");"},{"title":"Create a query, add a `ge` filter, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryContacts()\n .ge(\"info.birthdate\", \"1983-02-01\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `\"_createdDate\"`\r\n- `\"_updatedDate\"`\r\n- `\"lastActivity.activityDate\"`\r\n- `\"info.birthdate\"`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than or equal to the specified value.\r\n\r\nThe `ge()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property is greater than or equal to the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically,\r\n`\"abc\"` is greater than or equal to `\"ABC\"` (because of the greater than),\r\nbut `\"ABC\"` is not greater than or equal to `\"abc\"`","sdkErrors":[]},{"name":"gt","fqn":"Contacts.ContactsQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add a `gt` filter to a query","content":"const query = contacts.queryContacts().gt(\"_createdDate\", \"2021-01-01T00:00:00.000Z\");"},{"title":"Create a query, add a `gt` filter, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryContacts()\n .gt(\"info.birthdate\", \"1983-02-01T00:00:00.000Z\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `\"_createdDate\"`\r\n- `\"_updatedDate\"`\r\n- `\"lastActivity.activityDate\"`\r\n- `\"info.birthdate\"`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is greater than the specified value.\r\n\r\nThe `gt()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property is greater than the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`.","sdkErrors":[]},{"name":"hasAll","fqn":"Contacts.ContactsQueryBuilder.hasAll","slug":"has-all","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","values"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add a `hasAll` filter to a query","content":"const query = contacts.queryContacts()\n.hasAll(\"info.labelKeys\", [\"custom.white-glove-treatment\", \"custom.at-risk\"]);"},{"title":"Create a query, add a `hasAll` filter, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryContacts()\n .hasAll(\"info.labelKeys\", [\"custom.white-glove-treatment\", \"custom.at-risk\"])\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `info.labelKeys`"},{"name":"values","slug":"values","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The values to match against."}],"description":"Refines a query to match items whose specified property value contains all of the specified values.\r\n\r\nThe `hasAll()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the values of the array of the specified property equal all of\r\nthe specified values.\r\n\r\nMatching with `hasAll()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.","sdkErrors":[]},{"name":"hasSome","fqn":"Contacts.ContactsQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","values"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add a `hasSome` filter to a query","content":"const query = contacts.queryContacts()\n.hasSome(\"info.extendedFields.members.membershipStatus\", [\"APPROVED\", \"DENIED\", \"PENDING\", \"INACTIVE\"]);"},{"title":"Create a query, add a `hasSome` filter, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryContacts()\n .hasSome(\"info.labelKeys\", [\"custom.white-glove-treatment\", \"custom.at-risk\"])\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `\"_id\"`\r\n- `\"primaryInfo.email\"`\r\n- `\"primaryInfo.phone\"`\r\n- `\"info.name.first\"`\r\n- `\"info.name.last\"`\r\n- `\"info.emails.email\"`\r\n- `\"info.phones.phone\"`\r\n- `\"info.addresses.street\"`\r\n- `\"info.addresses.city\"`\r\n- `\"info.addresses.subdivision\"`\r\n- `\"info.addresses.country\"`\r\n- `\"info.company\"`\r\n- `\"info.jobTitle\"`\r\n- `\"info.locale\"`\r\n- `\"info.labelKeys\"`"},{"name":"values","slug":"values","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The values to match against."}],"description":"Refines a query to match items whose specified property value contains any of the specified values.\r\n\r\nThe `hasSome()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where any of the values of the array of the specified property equal any of\r\nthe specified values.\r\n\r\nMatching with `hasSome()` is case-sensitive in most instances, so `\"text\"` is not equal to `\"Text\"`.\r\nOne exception is email fields, which are case insensitive when matching with `hasSome()`.","sdkErrors":[]},{"name":"le","fqn":"Contacts.ContactsQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add an `le` filter to a query","content":"const query = contacts.queryContacts().le(\"_createdDate\", \"2021-01-01T00:00:00.000Z\");"},{"title":"Create a query, add an `le` filter, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryContacts()\n .le(\"info.birthdate\", \"1990-01-01\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `\"_createdDate\"`\r\n- `\"_updatedDate\"`\r\n- `\"lastActivity.activityDate\"`\r\n- `\"info.birthdate\"`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than or equal to the specified value.\r\n\r\nThe `le()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property is less than or equal to the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically,\r\nso `\"ABC\"` is less than or equal to `\"abc\"` (because of the less than),\r\nbut `\"abc\"` is not less than or equal to `\"ABC\"`.","sdkErrors":[]},{"name":"limit","fqn":"Contacts.ContactsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add a `limit` to a query","content":"const query = contacts.queryContacts().limit(10);"},{"title":"Create a query, add a `limit`, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n\n return contacts.queryContacts()\n .limit(10)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Limit the number of items to return, which is also the [`pageSize`](wix-crm-backend/contacts/contacts-query-result/pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\npage. Only one page of results is retrieved at a time. The [`next()`](wix-crm-backend/contacts/contacts-query-result/next)\r\nand [`prev()`](wix-crm-backend/contacts/contacts-query-result/prev) functions are used to\r\nnavigate the pages of a query result.\r\n\r\nBy default, `limit` is set to `50`.\r\n\r\nThe maximum value that `limit()` can accept is `1000`.","sdkErrors":[]},{"name":"lt","fqn":"Contacts.ContactsQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add an `lt` filter to a query","content":"const query = contacts.queryContacts().lt(\"info.birthdate\", \"1990-01-01\");"},{"title":"Create a query, add an `lt` filter, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryContacts()\n .lt(\"info.birthdate\", \"1990-01-01\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `\"_createdDate\"`\r\n- `\"_updatedDate\"`\r\n- `\"lastActivity.activityDate\"`\r\n- `\"info.birthdate\"`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value is less than the specified value.\r\n\r\nThe `lt()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property is less than the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nIf a property contains a number as a String, that value will be compared\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified property are ranked lowest.\r\n\r\nThe following types of properties can be compared:\r\n\r\n+ Number: Compares numerically.\r\n+ Date: Compares JavaScript Date objects.\r\n+ String: Compares lexicographically, so `\"Text\"` is less than `\"text\"`.","sdkErrors":[]},{"name":"ne","fqn":"Contacts.ContactsQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add an `ne` filter to a query","content":"const query = contacts.queryContacts().ne(\"info.company\", \"Wix\");"},{"title":"Create a query, add an `ne` filter, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryContacts()\n .ne(\"info.addresses.country\", \"GB\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `\"_id\"`\r\n- `\"_createdDate\"`\r\n- `\"_updatedDate\"`\r\n- `\"lastActivity.activityDate\"`\r\n- `\"primaryInfo.email\"`\r\n- `\"primaryInfo.phone\"`\r\n- `\"info.name.first\"`\r\n- `\"info.name.last\"`\r\n- `\"info.emails.email\"`\r\n- `\"info.phones.phone\"`\r\n- `\"info.addresses.street\"`\r\n- `\"info.addresses.city\"`\r\n- `\"info.addresses.subdivision\"`\r\n- `\"info.addresses.country\"`\r\n- `\"info.company\"`\r\n- `\"info.jobTitle\"`\r\n- `\"info.birthdate\"`\r\n- `\"info.locale\"`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value does not equal the specified value.\r\n\r\nThe `ne()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property does not equal the specified `value`.\r\n\r\nIt only matches values of the same type. For example, a number value stored\r\nas a String type does not match the same number stored as a Number type.\r\n\r\nMatching strings with `ne()` is case sensitive in most instances, so `\"text\"` is not equal to `\"Text\"`. \r\nOne exception is email fields, which are case insensitive when matching with `ne()`.\r\n\r\nIf the value of the `propertyName` property is an Array, `ne()` includes items\r\nin which none of the elements of the Array match the specified `value`.","sdkErrors":[]},{"name":"not","fqn":"Contacts.ContactsQueryBuilder.not","slug":"not","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add a `not` filter to a query","content":"const newQuery = query1.not(query2);"},{"title":"Create a query, add a `not` filter, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryContacts()\n .not(contacts.queryContacts()\n .hasSome(\"info.labelKeys\", \"custom.stale-lead\"))\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder"},"description":"Contains functionality for refining a contacts query.\r\nThe `ContactsQueryBuilder` functions enable you to run, sort, filter, and control\r\nwhich results a query returns.\r\n\r\nTypically, you build a query using `queryContacts()` function,\r\nrefine the query by chaining `ContactsQueryBuilder` functions, and then execute the\r\nquery by chaining the [`find()`](#find) function."}],"description":"Adds an `not` condition to the query.\r\n\r\nThe `not()` function adds a `not` condition to a `ContactsQueryBuilder`. A query\r\nwith a `not` returns all the items that match the query as defined up to\r\nthe `not` function, but don't match the query passed to the `not` function.\r\n\r\nIf the query only contains a `not()` function, it returns all the items\r\nthat don't match the query defined by the `not` method.","sdkErrors":[]},{"name":"or","fqn":"Contacts.ContactsQueryBuilder.or","slug":"or","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["query"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add an `or` filter to a query","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryContacts()\n .eq(\"info.addresses.country\", \"GB\")\n .or(contacts.queryContacts()\n .eq(\"info.addresses.country\", \"FR\"))\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"},{"title":"Create a query, add an `or` filter, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryContacts()\n .eq(\"info.addresses.country\", \"GB\")\n .or(contacts.queryContacts()\n .eq(\"info.addresses.country\", \"FR\"))\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder"},"description":"A query to add to the initial query as an `or` condition."}],"description":"Adds an `or` condition to the query.\r\n\r\nThe `or()` function adds an inclusive `or` condition to a `ContactsQueryBuilder`. A query\r\nwith an `or` returns all the items that match the query as defined up to\r\nthe `or` function, the items that match the query passed to the `or`\r\nfunction, and the items that match both.\r\n\r\nThe `or()` function is designed to work with 2 or more queries.\r\nIf you use it on its own, it will return all the items that meet the query criteria.","sdkErrors":[]},{"name":"skip","fqn":"Contacts.ContactsQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add a skip to a query","content":"const query = contacts.queryContacts().skip(10);"},{"title":"Create a query, add a skip, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, async () => {\n try {\n\n const results = await contacts.queryContacts()\n .skip(10)\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});"}],"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\nresults before returning new query results.\r\n\r\nFor example, if you query your contacts and 50 items match your query, but\r\nyou set `skip` to 10, the results returned will skip the first 10 items\r\nthat match and return the 11th through 50th items.\r\n\r\nBy default, `skip` is set to 0.","sdkErrors":[]},{"name":"startsWith","fqn":"Contacts.ContactsQueryBuilder.startsWith","slug":"starts-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName","value"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder","description":"A `ContactsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add a `startsWith` filter to a query","content":"const query = contacts.queryContacts().startsWith(\"info.jobTitle\", \"VP\");"},{"title":"Create a query, add a `startsWith` filter, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryContactsFunction = webMethod(Permissions.Anyone, () => {\n\n return contacts.queryContacts()\n .startsWith(\"info.company\", \"Goog\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The property whose value will be compared with `value`.\r\n\r\nSupported properties:\r\n\r\n- `\"primaryInfo.email\"`\r\n- `\"primaryInfo.phone\"`\r\n- `\"info.name.first\"`\r\n- `\"info.name.last\"`\r\n- `\"info.emails.email\"`\r\n- `\"info.phones.phone\"`\r\n- `\"info.addresses.street\"`\r\n- `\"info.addresses.city\"`\r\n- `\"info.company\"`\r\n- `\"info.jobTitle\"`"},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The value to match against."}],"description":"Refines a query to match items whose specified property value starts with a specified string.\r\n\r\nThe `startsWith()` function refines a `ContactsQueryBuilder` to only\r\nmatch items where the value of the specified property starts with a specified string.\r\nMatching with `startsWith()` is case-sensitive, so `\"TEXT\"` does not start with `\"tex\"`.\r\n\r\nYou can only use `startsWith()` with a property whose value is a String.","sdkErrors":[]}],"webhooks":[],"articles":[{"content":"# Introduction\nThe `ContactsQueryBuilder` functions enable you to run, sort, filter, and control\nwhich results a query returns.\n\nTypically, you build a query using the `queryContacts()` function,\nrefine the query by chaining `ContactsQueryBuilder` functions, and then execute the\nquery by chaining the [`find()`](wix-crm-backend/contacts/contacts-query-builder/find) function.\n\nFor example, the following code returns the first 5 contacts who work at Wix\nand sorts them by last name in ascending order:\n\n```javascript\nimport { contacts } from 'wix-crm-backend';\n\ncontacts.queryContacts()\n .eq(\"info.company\", \"Wix\")\n .ascending(\"info.name.last\")\n .limit(5)\n .find()\n .then( (results) => {\n return results.items;\n });\n```\n\n> **Note:**\n> Only visitors with\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\n> can query contacts.\n> You can override the permissions by setting the `suppressAuth` option to `true`\n> in the [`find()`](wix-crm-backend/contacts/contacts-query-builder/find) function.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"ContactsQueryResult","slug":"contacts-query-result","fqn":"Contacts.ContactsQueryResult","standaloneTypes":[],"metadata":{},"actions":[{"name":"hasNext","fqn":"Contacts.ContactsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"examples":[{"title":"Get whether the query result object has more results","content":"let hasNext = results.hasNext(); // true"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const retrieveAllItems = webMethod(Permissions.Anyone, async () => {\n let allItems = [];\n\n let results = await contacts.queryContacts()\n .limit(1000)\n .find();\n allItems = allItems.concat(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n\n return allItems;\n});"}],"description":"Indicates if the query has more results.","sdkErrors":[]},{"name":"hasPrev","fqn":"Contacts.ContactsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"examples":[{"title":"Get whether the query result object has previous results","content":"let hasPrev = results.hasPrev(); // false"}],"description":"Indicates if the query has previous results.","sdkErrors":[]},{"name":"next","fqn":"Contacts.ContactsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ContactsQueryResult","referenceFqn":"Contacts.ContactsQueryResult.ContactsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/contacts-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `ContactsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"examples":[{"title":"Get the next page of a query result","content":"const nextPage = oldResults.next()\n .then((results) => {\n return results;\n })\n .catch((error) => {\n console.error(error);\n });"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const retrieveAllItems = webMethod(Permissions.Anyone, async () => {\n let allItems = [];\n\n let results = await contacts.queryContacts()\n .limit(1000)\n .find();\n allItems = allItems.concat(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n\n return allItems;\n});"}],"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/contacts-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions.\r\n\r\nIf items are added or removed between calls to `next()` the values returned\r\nby `ContactsQueryResult` may change.","sdkErrors":[]},{"name":"prev","fqn":"Contacts.ContactsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ContactsQueryResult","referenceFqn":"Contacts.ContactsQueryResult.ContactsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/contacts-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `ContactsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"examples":[{"title":"Get the previous page of a query result","content":"const previousPage = oldResults.prev()\n .then((results) => {\n return results;\n })\n .catch((error) => {\n console.error(error);\n });"}],"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/contacts-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions.\r\n\r\nIf items are added or removed between calls to `prev()` the values returned\r\nby `ContactsQueryResult` may change.","sdkErrors":[]}],"webhooks":[],"articles":[{"content":"# Introduction\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/contacts-query-builder/find)\nfunction, it returns a Promise that resolves to a `ContactsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Perform a query and get the returned items from the result","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const getQueryResultItems = webMethod(Permissions.Anyone, () => {\n return contacts.queryContacts()\n .limit(5)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n return results.items;\n } else {\n console.log(\"No items found\");\n }\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* items:\n * [\n * {\n * \"_id\": \"a52852d7-e0d6-484b-93fe-bffdb670f08f\",\n * \"_createdDate\": \"2021-03-30T20:18:06.874Z\",\n * \"_updatedDate\": \"2021-03-31T00:10:13.607Z\",\n * \"revision\": 3,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Ari\",\n * \"last\": \"Thereyet\"\n * },\n * \"picture\": {},\n * \"emails\": [\n * {\n * \"_id\": \"e6f2733e-32b8-4d99-95ce-7d2e63a39108\",\n * \"tag\": \"HOME\",\n * \"email\": \"ari.thereyet@example.com\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"703f6faf-7d88-42ce-8e28-54f8d5f6e5e4\",\n * \"tag\": \"UNTAGGED\",\n * \"email\": \"ari.thereyet.appended.email@example.com\",\n * \"primary\": false\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"970380bb-57e0-4b3a-8f40-ccc93be1ab58\",\n * \"tag\": \"MOBILE\",\n * \"phone\": \"601-081-124\",\n * \"primary\": true\n * }\n * ],\n * \"labelKeys\": [\n * \"custom.stale-lead\"\n * ],\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Thereyet Ari\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"emailSubscriptions.effectiveEmail\": \"ari.thereyet.appended.email@example.com\",\n * \"contacts.displayByFirstName\": \"Ari Thereyet\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-30T20:18:06.872Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"primaryInfo\": {\n * \"email\": \"ari.thereyet@example.com\",\n * \"phone\": \"601-081-124\"\n * },\n * \"source\": {\n * \"sourceType\": \"WIX_APP\"\n * }\n * },\n * {\n * \"_id\": \"bc0ae72b-3285-485b-b0ad-c32c769a4daf\",\n * \"_createdDate\": \"2021-03-30T13:12:39.650Z\",\n * \"_updatedDate\": \"2021-03-30T13:12:39.650Z\",\n * \"revision\": 0,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Gene\",\n * \"last\": \"Lopez\"\n * },\n * \"company\": \"Borer and Sons, Attorneys at Law\",\n * \"birthdate\": \"1981-11-02\",\n * \"jobTitle\": \"Senior Staff Attorney\",\n * \"locale\": \"en-us\",\n * \"picture\": {\n * \"image\": \"https://randomuser.me/api/portraits/men/0.jpg\",\n * \"imageProvider\": \"EXTERNAL\"\n * },\n * \"emails\": [\n * {\n * \"_id\": \"5bdcce4a-37c2-46ed-b49c-d562c6e3c4ce\",\n * \"tag\": \"HOME\",\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"78e5f398-e148-448d-b490-7c0b7d2ab336\",\n * \"tag\": \"WORK\",\n * \"email\": \"gene.lopez@example.com\",\n * \"primary\": false\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"820e4640-ffe0-4980-a097-62a715e73135\",\n * \"tag\": \"MOBILE\",\n * \"countryCode\": \"US\",\n * \"phone\": \"(722)-138-3099\",\n * \"primary\": true\n * },\n * {\n * \"_id\": \"8506549e-e4f8-42f6-b6fc-9db155b582ef\",\n * \"tag\": \"HOME\",\n * \"countryCode\": \"US\",\n * \"phone\": \"(704)-454-1233\",\n * \"e164Phone\": \"+17044541233\",\n * \"primary\": false\n * }\n * ],\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"9834 Bollinger Rd\\nEl Cajon, WY 97766\\nUS\",\n * \"location\": {\n * \"latitude\": 84.1048,\n * \"longitude\": -116.8836\n * },\n * \"city\": \"El Cajon\",\n * \"subdivision\": \"US-WY\",\n * \"country\": \"US\",\n * \"postalCode\": \"97766\",\n * \"streetAddress\": {\n * \"name\": \"Bollinger Rd\",\n * \"number\": \"9834\",\n * \"apt\": \"\"\n * }\n * },\n * \"_id\": \"8532051f-91f2-42d9-9a97-9f2c39e64f7a\",\n * \"tag\": \"HOME\"\n * }\n * ],\n * \"labelKeys\": [\n * \"custom.white-glove-treatment\",\n * \"contacts.contacted-me\",\n * \"custom.new-lead\"\n * ],\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Lopez Gene\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"custom.event-we-met-at\": \"LegalBigData\",\n * \"emailSubscriptions.effectiveEmail\": \"gene.lopez.at.home@example.com\",\n * \"contacts.displayByFirstName\": \"Gene Lopez\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-30T13:12:39.649Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"primaryInfo\": {\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"phone\": \"(722)-138-3099\"\n * },\n * \"source\": {\n * \"sourceType\": \"OTHER\"\n * }\n * },\n * {\n * \"_id\": \"41b1c8e7-5ddd-4186-ad85-269985d6b296\",\n * \"_createdDate\": \"2021-03-29T21:16:54.801Z\",\n * \"_updatedDate\": \"2021-03-30T20:14:16.256Z\",\n * \"revision\": 3,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Renata\",\n * \"last\": \"Kirsten\"\n * },\n * \"picture\": {},\n * \"emails\": [\n * {\n * \"_id\": \"500569e4-144d-4f25-83a1-4a59956b698d\",\n * \"tag\": \"UNTAGGED\",\n * \"email\": \"renata.kirsten@example.com\",\n * \"primary\": true\n * }\n * ],\n * \"phones\": [\n * {\n * \"_id\": \"3ea63681-598a-45bc-88fb-97fefdfd5a74\",\n * \"tag\": \"UNTAGGED\",\n * \"phone\": \"0177-3234750\",\n * \"primary\": true\n * }\n * ],\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"6677 Schlossstraße\\n48435 Wittenberg\\nGermany\",\n * \"city\": \"Wittenberg\",\n * \"subdivision\": \"DE-TH\",\n * \"country\": \"DE\",\n * \"postalCode\": \"48435\",\n * \"addressLine1\": \"6677 Schlossstraße\"\n * },\n * \"_id\": \"b36d1a2d-9a6b-48c3-a463-c8b116303e9f\",\n * \"tag\": \"SHIPPING\"\n * },\n * {\n * \"address\": {\n * \"formatted\": \"6677 Schlossstraße\\n48435 Wittenberg\\nGermany\",\n * \"city\": \"Wittenberg\",\n * \"subdivision\": \"DE-TH\",\n * \"country\": \"DE\",\n * \"postalCode\": \"48435\",\n * \"addressLine1\": \"6677 Schlossstraße\"\n * },\n * \"_id\": \"2a3fc791-cbad-4ecd-8bf6-8072b2793e3a\",\n * \"tag\": \"BILLING\"\n * }\n * ],\n * \"labelKeys\": [\n * \"contacts.customers\"\n * ],\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Kirsten Renata\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"ecom.lastPurchaseDate\": \"2021-03-29T21:17:01.122Z\",\n * \"ecom.numOfPurchases\": 1,\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"ecom.totalSpentAmount\": 120,\n * \"emailSubscriptions.effectiveEmail\": \"renata.kirsten@example.com\",\n * \"contacts.displayByFirstName\": \"Renata Kirsten\",\n * \"ecom.totalSpentCurrency\": \"ILS\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-29T21:17:01.122Z\",\n * \"activityType\": \"ECOM_PURCHASE\"\n * },\n * \"primaryInfo\": {\n * \"email\": \"renata.kirsten@example.com\",\n * \"phone\": \"0177-3234750\"\n * },\n * \"source\": {\n * \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n * \"sourceType\": \"WIX_STORES\"\n * }\n * },\n * {\n * \"_id\": \"67bcea88-b748-4cc8-a584-bb991b6e5d82\",\n * \"_createdDate\": \"2021-03-29T21:06:53.976Z\",\n * \"_updatedDate\": \"2021-03-29T21:06:53.976Z\",\n * \"revision\": 0,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Ljiljana\",\n * \"last\": \"Francois\"\n * },\n * \"birthdate\": \"1981-09-13\",\n * \"jobTitle\": \"Creative Director\",\n * \"company\": \"Happy Mouse Productions\",\n * \"locale\": \"en-us\",\n * \"emails\": [\n * {\n * \"_id\": \"c030ed4c-e127-4f02-8256-8984415e0321\",\n * \"tag\": \"MAIN\",\n * \"email\": \"ljiljana.francois@example.com\",\n * \"primary\": true\n * }\n * ],\n * \"picture\": {},\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Francois Ljiljana\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"emailSubscriptions.effectiveEmail\": \"ljiljana.francois@example.com\",\n * \"contacts.displayByFirstName\": \"Ljiljana Francois\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-29T21:06:53.975Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"primaryInfo\": {\n * \"email\": \"ljiljana.francois@example.com\"\n * },\n * \"source\": {\n * \"sourceType\": \"OTHER\"\n * }\n * },\n * {\n * \"_id\": \"1626081c-3b3c-4b44-855b-1acb1122e080\",\n * \"_createdDate\": \"2021-03-29T20:51:21.216Z\",\n * \"_updatedDate\": \"2021-03-30T11:50:42.040Z\",\n * \"revision\": 6,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Celine\",\n * \"last\": \"Rousseau\"\n * },\n * \"locale\": \"en\",\n * \"picture\": {},\n * \"emails\": [\n * {\n * \"tag\": \"UNTAGGED\",\n * \"email\": \"celine.rousseau@example.com\",\n * \"primary\": true\n * }\n * ],\n * \"phones\": [\n * {\n * \"tag\": \"UNTAGGED\",\n * \"phone\": \"0177-7912572\",\n * \"primary\": true\n * }\n * ],\n * \"addresses\": [\n * {\n * \"address\": {\n * \"formatted\": \"2451Rue des Cuirassiers\\n9502 Grosshöchstetten\\nSwitzerland\",\n * \"city\": \"Grosshöchstetten\",\n * \"subdivision\": \"CH-VD\",\n * \"country\": \"CH\",\n * \"postalCode\": \"9502\",\n * \"addressLine1\": \"2451Rue des Cuirassiers\"\n * },\n * \"tag\": \"SHIPPING\"\n * },\n * {\n * \"address\": {\n * \"formatted\": \"2451Rue des Cuirassiers\\n9502 Grosshöchstetten\\nSwitzerland\",\n * \"city\": \"Grosshöchstetten\",\n * \"subdivision\": \"CH-VD\",\n * \"country\": \"CH\",\n * \"postalCode\": \"9502\",\n * \"addressLine1\": \"2451Rue des Cuirassiers\"\n * },\n * \"tag\": \"BILLING\"\n * },\n * {\n * \"address\": {\n * \"formatted\": \"Israel\",\n * \"country\": \"IL\"\n * },\n * \"tag\": \"UNTAGGED\"\n * }\n * ],\n * \"labelKeys\": [\n * \"contacts.customers\"\n * ],\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Rousseau Celine\",\n * \"emailSubscriptions.deliverabilityStatus\": \"BOUNCED\",\n * \"ecom.lastPurchaseDate\": \"2021-03-29T21:00:35.835Z\",\n * \"members.membershipStatus\": \"APPROVED\",\n * \"ecom.numOfPurchases\": 2,\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"ecom.totalSpentAmount\": 27.5,\n * \"members.mobile\": false,\n * \"contacts.displayByFirstName\": \"Celine Rousseau\",\n * \"ecom.totalSpentCurrency\": \"ILS\"\n * }\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-29T20:58:47.548Z\",\n * \"activityType\": \"MEMBER_STATUS_CHANGED\"\n * },\n * \"primaryInfo\": {\n * \"email\": \"celine.rousseau@example.com\",\n * \"phone\": \"0177-7912572\"\n * },\n * \"source\": {\n * \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n * \"sourceType\": \"WIX_STORES\"\n * }\n * }\n * ]\n */"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Contact","referenceFqn":"Contacts.Contact"}},"description":"Returns the items that match the query.\r\n\r\nThe current page of items retrieved by the query.\r\n\r\nList of contacts.\r\n\r\n\r\n> **Note:** When no items match the query, the items array is empty.\r\n\r\nTo paginate your query results, use the `ContactsQueryResult` pagination properties and functions."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the `length` of a query result","content":"let resultLength = results.length; // 20"},{"title":"Perform a query and get the `length` of the result","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const getPageLength = webMethod(Permissions.Anyone, async () => {\n try {\n const results = await contacts.queryContacts().find();\n return results.length; // 20\n } catch (error) {\n console.error(error);\n }\n});"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/contacts-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the page size of a query result","content":"let resultPageSize = results.pageSize; // 50"},{"title":"Perform a query and get the page size of the result","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const getPageSize = webMethod(Permissions.Anyone, async () => {\n try {\n const results = await contacts.queryContacts().find();\n return results.pageSize; // 50\n } catch (error) {\n console.error(error);\n }\n});"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/contacts-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query that produced the current result","content":"let resultQuery = results.query;"},{"title":"Perform a query and get the query that produced the result","content":"import { contacts } from 'wix-crm-backend';\n\n// ...\n\nconst originalQueryResults = await contacts.queryContacts()\n .find();\n\nconst newQueryResults = await originalQueryResults.query\n .eq(\"info.addresses.country\", \"GB\")\n .find();\n\nconst firstItem = newQueryResults.items[0];"}],"type":{"kind":"REFERENCE","name":"ContactsQueryBuilder","referenceFqn":"Contacts.ContactsQueryBuilder.ContactsQueryBuilder"},"description":"Returns the `ContactsQueryBuilder` object used to get the current results.\r\n\r\nUse the `query` property to create and run a new query\r\nby chaining additional `ContactsQueryBuilder` functions to it."}]},{"name":"ExtendedFieldsQueryBuilder","slug":"extended-fields-query-builder","fqn":"Contacts.ExtendedFieldsQueryBuilder","standaloneTypes":[],"metadata":{},"actions":[{"name":"ascending","fqn":"Contacts.ExtendedFieldsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryBuilder","referenceFqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder","description":"A `ExtendedFieldsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add an `ascending` sort to a query","content":"const query = contacts.queryExtendedFields().descending(\"_createdDate\");"},{"title":"Create a query, add an `ascending` sort, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myqueryExtendedFieldsFunction = webMethod(Permissions.Anyone, () => {\n\n return contacts.queryExtendedFields()\n .ascending(\"_createdDate\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n\r\n- `_createdDate`\r\n- `_updatedDate`\r\n- `displayName`"}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `ExtendedFieldsQueryBuilder` to sort in ascending order of\r\nthe specified properties. If you specify more than one property,\r\n`ascending()` sorts the results in ascending order by each property in the\r\norder they are listed.\r\n\r\nYou can sort the following types:\r\n\r\n+ Number: Sorts numerically.\r\n+ Date: Sorts by date and time.\r\n+ String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\nIf a property contains a number as a String, that value will be sorted\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified sort property are ranked lowest.","sdkErrors":[]},{"name":"descending","fqn":"Contacts.ExtendedFieldsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryBuilder","referenceFqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder","description":"A `ExtendedFieldsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add an `descending` sort to a query","content":"const query = contacts.queryExtendedFields().descending(\"_createdDate\");"},{"title":"Create a query, add an `descending` sort, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myqueryExtendedFieldsFunction = webMethod(Permissions.Anyone, () => {\n\n return contacts.queryExtendedFields()\n .descending(\"_createdDate\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n\r\n- `_createdDate`\r\n- `_updatedDate`\r\n- `displayName`"}],"description":"Adds a sort to a query, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `ExtendedFieldsQueryBuilder` to sort in ascending order of\r\nthe specified properties. If you specify more than one property,\r\n`descending()` sorts the results in descending order by each property in the\r\norder they are listed.\r\n\r\nYou can sort the following types:\r\n\r\n+ Number: Sorts numerically.\r\n+ Date: Sorts by date and time.\r\n+ String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\nIf a property contains a number as a String, that value will be sorted\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified sort property are ranked lowest.","sdkErrors":[]},{"name":"find","fqn":"Contacts.ExtendedFieldsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryResult","referenceFqn":"Contacts.ExtendedFieldsQueryResult.ExtendedFieldsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/extended-fields-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `ExtendedFieldsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"examples":[{"title":"Run a query with no sorting","content":"const queryResults = contacts.queryExtendedFields().find();"},{"title":"Perform a `find` on a query","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myqueryExtendedFieldsFunction = webMethod(Permissions.Anyone, () => {\n\n return contacts.queryExtendedFields()\n .find({\n suppressAuth: false\n })\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Returns the items that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\nby the query and some information about the results. The Promise is\r\nrejected if `find()` is called with incorrect permissions or if any of the\r\nfunctions used to refine the query are invalid.\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can query extended fields.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"limit","fqn":"Contacts.ExtendedFieldsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryBuilder","referenceFqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder","description":"A `ExtendedFieldsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add a `limit` to a query","content":"const query = contacts.queryExtendedFields().limit(10);"},{"title":"Create a query, add a `limit`, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myqueryExtendedFieldsFunction = webMethod(Permissions.Anyone, () => {\n\n return contacts.queryExtendedFields()\n .limit(10)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });\n\n});"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Limit the number of items to return, which is also the [`pageSize`](wix-crm-backend/contacts/extended-fields-query-result/pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\npage. Only one page of results is retrieved at a time. The [`next()`](wix-crm-backend/contacts/extended-fields-query-result/next)\r\nand [`prev()`](wix-crm-backend/contacts/extended-fields-query-result/prev) functions are used to\r\nnavigate the pages of a query result.\r\n\r\nBy default, `limit` is set to `50`.\r\n\r\nThe maximum value that `limit()` can accept is `1000`.","sdkErrors":[]},{"name":"skip","fqn":"Contacts.ExtendedFieldsQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryBuilder","referenceFqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder","description":"A `ExtendedFieldsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add a skip to a query","content":"const query = contacts.queryExtendedFields().skip(10);"},{"title":"Create a query, add a skip, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myqueryExtendedFieldsFunction = webMethod(Permissions.Anyone, () => {\n\n return contacts.queryExtendedFields()\n .limit(10)\n .skip(10)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\nresults before returning new query results.\r\n\r\nFor example, if you query your contacts and 50 items match your query, but\r\nyou set `skip` to 10, the results returned will skip the first 10 items\r\nthat match and return the 11th through 50th items.\r\n\r\nBy default, `skip` is set to 0.","sdkErrors":[]}],"webhooks":[],"articles":[{"content":"# Introduction\nThe `ExtendedFieldsQueryBuilder` allows you to run, sort, and control\nwhich results a query returns.\n\nTypically, you build a query using the `queryExtendedFields()` function,\nrefine the query by chaining `ExtendedFieldsQueryBuilder` functions, and then execute the\nquery by chaining the [`find()`](#find) function.\n\nFor example, the following code returns the first 5 extended fields that were created\nby sorting them in ascending order:\n\n```javascript\nimport { contacts } from 'wix-crm-backend';\n\ncontacts.queryExtendedFields()\n .ascending(\"_createdDate\")\n .limit(5)\n .find()\n .then( (results) => {\n return results.items;\n });\n```\n\n> **Note:**\n> Only visitors with\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\n> can query extended fields.\n> You can override the permissions by setting the `suppressAuth` option to `true`\n> in the [`find()`](wix-crm-backend/contacts/extended-fields-query-builder/find) function.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"ExtendedFieldsQueryResult","slug":"extended-fields-query-result","fqn":"Contacts.ExtendedFieldsQueryResult","standaloneTypes":[],"metadata":{},"actions":[{"name":"hasNext","fqn":"Contacts.ExtendedFieldsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"examples":[{"title":"Get whether the query result object has more results","content":"let hasNext = results.hasNext(); // true"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const retrieveAllItems = webMethod(Permissions.Anyone, async () => {\n let allItems = [];\n\n let results = await contacts.queryExtendedFields()\n .limit(1000)\n .find();\n allItems = allItems.concat(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n\n return allItems;\n});"}],"description":"Indicates if the query has more results.","sdkErrors":[]},{"name":"hasPrev","fqn":"Contacts.ExtendedFieldsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"examples":[{"title":"Get whether the query result object has previous results","content":"let hasPrev = results.hasPrev(); // false"}],"description":"Indicates if the query has previous results.","sdkErrors":[]},{"name":"next","fqn":"Contacts.ExtendedFieldsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryResult","referenceFqn":"Contacts.ExtendedFieldsQueryResult.ExtendedFieldsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/extended-fields-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `ExtendedFieldsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"examples":[{"title":"Get the next page of a query result","content":"const nextPage = oldResults.next()\n .then((results) => {\n return results;\n })\n .catch((error) => {\n console.error(error);\n });"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const retrieveAllItems = webMethod(Permissions.Anyone, async () => {\n let allItems = [];\n\n let results = await contacts.queryExtendedFields()\n .limit(1000)\n .find();\n allItems = allItems.concat(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n\n return allItems;\n});"}],"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/extended-fields-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions.\r\n\r\nIf items are added or removed between calls to `next()` the values returned\r\nby `ExtendedFieldsQueryResult` may change.","sdkErrors":[]},{"name":"prev","fqn":"Contacts.ExtendedFieldsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ExtendedFieldsQueryResult","referenceFqn":"Contacts.ExtendedFieldsQueryResult.ExtendedFieldsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/extended-fields-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `ExtendedFieldsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"examples":[{"title":"Get the previous page of a query result","content":"const previousPage = oldResults.prev()\n .then((results) => {\n return results;\n })\n .catch((error) => {\n console.error(error);\n });"}],"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/extended-fields-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions.\r\n\r\nIf items are added or removed between calls to `prev()` the values returned\r\nby `ExtendedFieldsQueryResult` may change.","sdkErrors":[]}],"webhooks":[],"articles":[{"content":"# Introduction\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/extended-fields-query-builder/find)\nfunction, it returns a Promise that resolves to a `ExtendedFieldsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Perform a query and get the returned items from the result","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const getQueryResultItems = webMethod(Permissions.Anyone, () => {\n return contacts.queryExtendedFields()\n .limit(10)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n return results.items;\n } else {\n console.log(\"No items found\");\n }\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* items:\n * [\n * {\n * \"_createdDate\": \"2021-03-30T12:41:13.000Z\",\n * \"dataType\": \"TEXT\",\n * \"displayName\": \"Event we met at\",\n * \"fieldType\": \"USER_DEFINED\",\n * \"key\": \"custom.event-we-met-at\",\n * \"namespace\": \"custom\",\n * \"_updatedDate\": \"2021-03-30T12:41:13.000Z\"\n * },\n * {\n * \"_createdDate\": \"2021-01-19T23:18:17.000Z\",\n * \"dataType\": \"DATE\",\n * \"displayName\": \"Last Contacted\",\n * \"fieldType\": \"USER_DEFINED\",\n * \"key\": \"custom.last-contacted\",\n * \"namespace\": \"custom\",\n * \"_updatedDate\": \"2021-01-19T23:18:17.000Z\"\n * },\n * {\n * \"dataType\": \"TEXT\",\n * \"description\": \"Display name starting with last name (read only)\",\n * \"displayName\": \"Display Name (start with last)\",\n * \"fieldType\": \"SYSTEM\",\n * \"key\": \"contacts.displayByLastName\",\n * \"namespace\": \"contacts\"\n * },\n * {\n * \"dataType\": \"TEXT\",\n * \"description\": \"Vat ID for Wix Invoices\",\n * \"displayName\": \"VAT ID\",\n * \"fieldType\": \"SYSTEM\",\n * \"key\": \"invoices.vatId\",\n * \"namespace\": \"invoices\"\n * },\n * {\n * \"dataType\": \"TEXT\",\n * \"description\": \"APPROVED/DENIED/PENDING/INACTIVE (read only)\",\n * \"displayName\": \"Membership Status\",\n * \"fieldType\": \"SYSTEM\",\n * \"key\": \"members.membershipStatus\",\n * \"namespace\": \"members\"\n * },\n * {\n * \"dataType\": \"NUMBER\",\n * \"description\": \"Wix Stores purchase count (read only)\",\n * \"displayName\": \"# of Purchases\",\n * \"fieldType\": \"SYSTEM\",\n * \"key\": \"ecom.numOfPurchases\",\n * \"namespace\": \"ecom\"\n * },\n * {\n * \"dataType\": \"NUMBER\",\n * \"description\": \"Wix Stores aggregated spent amount (read only)\",\n * \"displayName\": \"Total Spent Amount\",\n * \"fieldType\": \"SYSTEM\",\n * \"key\": \"ecom.totalSpentAmount\",\n * \"namespace\": \"ecom\"\n * },\n * {\n * \"dataType\": \"TEXT\",\n * \"description\": \"Wix Stores currency code (read only)\",\n * \"displayName\": \"Total Spent Currency\",\n * \"fieldType\": \"SYSTEM\",\n * \"key\": \"ecom.totalSpentCurrency\",\n * \"namespace\": \"ecom\"\n * },\n * {\n * \"dataType\": \"DATE\",\n * \"description\": \"Wix Stores last purchase date (read only)\",\n * \"displayName\": \"Last Purchase Date\",\n * \"fieldType\": \"SYSTEM\",\n * \"key\": \"ecom.lastPurchaseDate\",\n * \"namespace\": \"ecom\"\n * },\n * {\n * \"dataType\": \"TEXT\",\n * \"description\": \"SUBSCRIBED/UNSUBSCRIBED/NOT_SET/PENDING (read only)\",\n * \"displayName\": \"Effective Subscription Status\",\n * \"fieldType\": \"SYSTEM\",\n * \"key\": \"emailSubscriptions.subscriptionStatus\",\n * \"namespace\": \"emailSubscriptions\"\n * },\n * {\n * \"dataType\": \"TEXT\",\n * \"description\": \"VALID/BOUNCED/SPAM_COMPLAINT/INACTIVE (read only)\",\n * \"displayName\": \"Effective Deliverability Status\",\n * \"fieldType\": \"SYSTEM\",\n * \"key\": \"emailSubscriptions.deliverabilityStatus\",\n * \"namespace\": \"emailSubscriptions\"\n * }\n * ]\n */"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ExtendedField","referenceFqn":"Contacts.ExtendedField"}},"description":"Returns the items that match the query.\r\n\r\nThe current page of items retrieved by the query.\r\n\r\nList of extended fields.\r\n\r\n> **Note:** When no items match the query, the items array is empty.\r\n\r\nTo paginate your query results, use the `ExtendedFieldsQueryResult` pagination properties and functions."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the `length` of a query result","content":"let resultLength = results.length; // 20"},{"title":"Perform a query and get the `length` of the result","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const getPageLength = webMethod(Permissions.Anyone, () => {\n return contacts.queryExtendedFields()\n .find()\n .then((results) => {\n return results.length; // 20\n })\n .catch((error) => {\n console.error(error);\n });\n});"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/extended-fields-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the page size of a query result","content":"let resultPageSize = results.pageSize; // 50"},{"title":"Perform a query and get the page size of the result","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const getPageSize = webMethod(Permissions.Anyone, async () => {\n try {\n const results = await contacts.queryExtendedFields().find();\n return results.pageSize; // 50\n } catch (error) {\n console.error(error);\n }\n});"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/extended-fields-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query that produced the current result","content":"let resultQuery = results.query;"},{"title":"Perform a query and get the query that produced the result","content":"import { contacts } from 'wix-crm-backend';\n\n// ...\n\nconst originalQueryResults = await contacts.queryExtendedFields()\n .find();\n\nconst newQueryResults = await originalQueryResults.query\n .descending(\"_createdDate\")\n .find();\n\nconst firstItem = newQueryResults.items[0];"}],"type":{"kind":"REFERENCE","name":"ExtendedFieldsQueryBuilder","referenceFqn":"Contacts.ExtendedFieldsQueryBuilder.ExtendedFieldsQueryBuilder"},"description":"Returns the `ExtendedFieldsQueryBuilder` object used to get the current results.\r\n\r\nUse the `query` property to create and run a new query\r\nby chaining additional `ExtendedFieldsQueryBuilder` functions to it.\r\nYou can filter only on properties that have not not already been used in the previous query."}]},{"name":"LabelsQueryBuilder","slug":"labels-query-builder","fqn":"Contacts.LabelsQueryBuilder","standaloneTypes":[],"metadata":{},"actions":[{"name":"ascending","fqn":"Contacts.LabelsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LabelsQueryBuilder","referenceFqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder","description":"A `LabelsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add an `ascending` sort to a query","content":"const query = contacts.queryLabels().descending(\"_createdDate\");"},{"title":"Create a query, add an `ascending` sort, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myqueryLabelsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryLabels()\n .ascending(\"_createdDate\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n\r\n- `_createdDate`\r\n- `_updatedDate`\r\n- `displayName`"}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\r\n\r\nThe `ascending()` function refines a `LabelsQueryBuilder` to sort in ascending order of\r\nthe specified properties. If you specify more than one property,\r\n`ascending()` sorts the results in ascending order by each property in the\r\norder they are listed.\r\n\r\nYou can sort the following types:\r\n\r\n+ Number: Sorts numerically.\r\n+ Date: Sorts by date and time.\r\n+ String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\nIf a property contains a number as a String, that value will be sorted\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified sort property are ranked lowest.","sdkErrors":[]},{"name":"descending","fqn":"Contacts.LabelsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["propertyName"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LabelsQueryBuilder","referenceFqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder","description":"A `LabelsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add an `descending` sort to a query","content":"const query = contacts.queryLabels().descending(\"_createdDate\");"},{"title":"Create a query, add an `descending` sort, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myqueryLabelsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryLabels()\n .descending(\"_createdDate\")\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The properties used in the sort.\r\n\r\nSupported properties:\r\n\r\n- `_createdDate`\r\n- `_updatedDate`\r\n- `displayName`"}],"description":"Adds a sort to a query, sorting by the specified properties in descending order.\r\n\r\nThe `descending()` function refines a `LabelsQueryBuilder` to sort in ascending order of\r\nthe specified properties. If you specify more than one property,\r\n`descending()` sorts the results in descending order by each property in the\r\norder they are listed.\r\n\r\nYou can sort the following types:\r\n\r\n+ Number: Sorts numerically.\r\n+ Date: Sorts by date and time.\r\n+ String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\r\n\r\nIf a property contains a number as a String, that value will be sorted\r\nalphabetically and not numerically. Items that do not have a value for the\r\nspecified sort property are ranked lowest.","sdkErrors":[]},{"name":"find","fqn":"Contacts.LabelsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"LabelsQueryResult","referenceFqn":"Contacts.LabelsQueryResult.LabelsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/labels-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `LabelsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"examples":[{"title":"Run a query with no sorting","content":"const queryResults = contacts.queryLabels().find();"},{"title":"Perform a `find` on a query","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryLabelsFunction = webMethod(Permissions.Anyone, () => {\n\n return contacts.queryLabels()\n .find({\n suppressAuth: false\n })\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n })\n\n});"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AuthOptions","referenceFqn":"Contacts.AuthOptions"},"description":"Authorization options."}],"description":"Returns the items that match the query.\r\n\r\nThe `find()` function returns a Promise that resolves to the results found\r\nby the query and some information about the results. The Promise is\r\nrejected if `find()` is called with incorrect permissions or if any of the\r\nfunctions used to refine the query are invalid.\r\n\r\n> **Note:**\r\n> Only visitors with\r\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\r\n> can query labels.\r\n> You can override the permissions by setting the `suppressAuth` option to `true`.","sdkErrors":[]},{"name":"limit","fqn":"Contacts.LabelsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["limit"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LabelsQueryBuilder","referenceFqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder","description":"A `LabelsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add a `limit` to a query","content":"const query = contacts.queryLabels().limit(10);"},{"title":"Create a query, add a `limit`, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryLabelsFunction = webMethod(Permissions.Anyone, () => {\n return contacts.queryLabels()\n .limit(10)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n })\n .catch((error) => {\n console.error(error);\n });\n\n});"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Limit the number of items to return, which is also the [`pageSize`](wix-crm-backend/contacts/labels-query-result/pageSize) of the results object."}],"description":"Limits the number of items the query returns.\r\n\r\nThe `limit()` function defines the number of results a query returns in each\r\npage. Only one page of results is retrieved at a time. The [`next()`](wix-crm-backend/contacts/labels-query-result/next)\r\nand [`prev()`](wix-crm-backend/contacts/labels-query-result/prev) functions are used to\r\nnavigate the pages of a query result.\r\n\r\nBy default, `limit` is set to `50`.\r\n\r\nThe maximum value that `limit()` can accept is `1000`.","sdkErrors":[]},{"name":"skip","fqn":"Contacts.LabelsQueryBuilder.skip","slug":"skip","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["skip"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"LabelsQueryBuilder","referenceFqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder","description":"A `LabelsQueryBuilder` object that contains the refined query."},"examples":[{"title":"Add a skip to a query","content":"const query = contacts.queryLabels().skip(10);"},{"title":"Create a query, add a skip, and run it","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const myQueryLabelsFunction = webMethod(Permissions.Anyone, async () => {\n try {\n\n const results = await contacts.queryLabels()\n .skip(10)\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle case where no matching items found\n }\n\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});"}],"actionParams":[{"name":"skip","slug":"skip","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The number of items to skip in the query results before returning the results."}],"description":"Sets the number of items to skip before returning query results.\r\n\r\nThe `skip()` function defines the number of results to skip in the query\r\nresults before returning new query results.\r\n\r\nFor example, if you query your contacts and 50 items match your query, but\r\nyou set `skip` to 10, the results returned will skip the first 10 items\r\nthat match and return the 11th through 50th items.\r\n\r\nBy default, `skip` is set to 0.","sdkErrors":[]}],"webhooks":[],"articles":[{"content":"# Introduction\nThe `LabelsQueryBuilder` allows you to run, sort, and control\nwhich results a query returns.\n\nTypically, you build a query using the `queryLabels()` function,\nrefine the query by chaining `LabelsQueryBuilder` functions, and then execute the\nquery by chaining the [`find()`](wix-crm-backend/contacts/query-labels/find) function.\n\nFor example, the following code returns the first 5 labels that were created\nby sorting them in ascending order:\n\n```javascript\nimport { contacts } from 'wix-crm-backend';\n\ncontacts.queryLabels()\n .ascending(\"_createdDate\")\n .limit(5)\n .find()\n .then( (results) => {\n return results.items;\n });\n```\n\n> **Note:**\n> Only visitors with\n> **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)\n> can query labels.\n> You can override the permissions by setting the `suppressAuth` option to `true`\n> in the [`find()`](wix-crm-backend/contacts/query-labels/find) function.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"LabelsQueryResult","slug":"labels-query-result","fqn":"Contacts.LabelsQueryResult","standaloneTypes":[],"metadata":{},"actions":[{"name":"hasNext","fqn":"Contacts.LabelsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are more results."},"examples":[{"title":"Get whether the query result object has more results","content":"let hasNext = results.hasNext(); // true"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const retrieveAllItems = webMethod(Permissions.Anyone, async () => {\n let allItems = [];\n\n let results = await contacts.queryContacts()\n .limit(1000)\n .find();\n allItems = allItems.concat(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n\n return allItems;\n});\n"}],"description":"Indicates if the query has more results.","sdkErrors":[]},{"name":"hasPrev","fqn":"Contacts.LabelsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean","description":"`true` if there are previous results."},"examples":[{"title":"Get whether the query result object has previous results","content":"let hasPrev = results.hasPrev(); // false"}],"description":"Indicates if the query has previous results.","sdkErrors":[]},{"name":"next","fqn":"Contacts.LabelsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"LabelsQueryResult","referenceFqn":"Contacts.LabelsQueryResult.LabelsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/labels-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `LabelsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"examples":[{"title":"Get the next page of a query result","content":"const nextPage = oldResults.next()\n .then((results) => {\n return results;\n })\n .catch((error) => {\n console.error(error);\n });"},{"title":"Iterate through all pages of query results","description":"This example demonstrates how to get all query results, bypassing the maximum limit of 1000.","content":"\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const retrieveAllItems = webMethod(Permissions.Anyone, async () => {\n let allItems = [];\n\n let results = await contacts.queryContacts()\n .limit(1000)\n .find();\n allItems = allItems.concat(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems = allItems.concat(results.items);\n }\n\n return allItems;\n});\n"}],"description":"Retrieves the next page of query results.\r\n\r\nThe `next()` function retrieves the next page of query results.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/labels-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions.\r\n\r\nIf items are added or removed between calls to `next()` the values returned\r\nby `LabelsQueryResult` may change.","sdkErrors":[]},{"name":"prev","fqn":"Contacts.LabelsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"LabelsQueryResult","referenceFqn":"Contacts.LabelsQueryResult.LabelsQueryResult"},"description":"Fulfilled - The results of a contacts query, containing the retrieved items.\r\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/labels-query-builder/find)\r\nfunction, it returns a Promise that resolves to a `LabelsQueryResult` object.\r\nThis object contains the items that match the query, information about the\r\nquery itself, and functions for paging through the query results."},"examples":[{"title":"Get the previous page of a query result","content":"const previousPage = oldResults.prev()\n .then((results) => {\n return results;\n })\n .catch((error) => {\n console.error(error);\n });"}],"description":"Retrieves the previous page of query results.\r\n\r\nThe `prev()` function retrieves the previous page of query results.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/labels-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions.\r\n\r\nIf items are added or removed between calls to `prev()` the values returned\r\nby `LabelsQueryResult` may change.","sdkErrors":[]}],"webhooks":[],"articles":[{"content":"# Introduction\nWhen you execute a query with the [`find()`](wix-crm-backend/contacts/labels-query-builder/find)\nfunction, it returns a Promise that resolves to a `LabelsQueryResult` object.\nThis object contains the items that match the query, information about the\nquery itself, and functions for paging through the query results.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[{"name":"items","slug":"items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Perform a query and get the returned items from the result","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const getQueryResultItems = webMethod(Permissions.Anyone, () => {\n return contacts.queryLabels()\n .limit(5)\n .find()\n .then((results) => {\n if (results.items.length > 0) {\n return results.items;\n } else {\n console.log(\"No items found\");\n }\n })\n .catch((error) => {\n console.error(error);\n });\n});\n\n/* items:\n * [\n * {\n * \"_createdDate\": \"2021-01-20T06:55:58.000Z\",\n * \"displayName\": \"White Glove Treatment\",\n * \"key\": \"custom.white-glove-treatment\",\n * \"labelType\": \"USER_DEFINED\",\n * \"namespace\": \"custom\",\n * \"_updatedDate\": \"2021-01-20T06:55:58.000Z\"\n * },\n * {\n * \"_createdDate\": \"2021-01-20T06:55:47.000Z\",\n * \"displayName\": \"At Risk\",\n * \"key\": \"custom.at-risk\",\n * \"labelType\": \"USER_DEFINED\",\n * \"namespace\": \"custom\",\n * \"_updatedDate\": \"2021-01-20T06:55:47.000Z\"\n * },\n * {\n * \"_createdDate\": \"2021-01-20T00:31:41.000Z\",\n * \"displayName\": \"Active Customer\",\n * \"key\": \"custom.active-customer\",\n * \"labelType\": \"USER_DEFINED\",\n * \"namespace\": \"custom\",\n * \"_updatedDate\": \"2021-01-20T00:31:41.000Z\"\n * },\n * {\n * \"displayName\": \"Customers\",\n * \"key\": \"contacts.customers\",\n * \"labelType\": \"SYSTEM\",\n * \"namespace\": \"contacts\",\n * },\n * {\n * \"displayName\": \"Contacted Me\",\n * \"key\": \"contacts.contacted-me\",\n * \"labelType\": \"SYSTEM\",\n * \"namespace\": \"contacts\",\n * }\n * ]\n */"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Label","referenceFqn":"Contacts.Label"}},"description":"Returns the items that match the query.\r\n\r\nThe current page of items retrieved by the query.\r\n\r\nList of labels.\r\n\r\n> **Note:** When no items match the query, the items array is empty.\r\n\r\nTo paginate your query results, use the `LabelsQueryResult` pagination properties and functions."},{"name":"length","slug":"length","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the `length` of a query result","content":"let resultLength = results.length; // 20"},{"title":"Perform a query and get the `length` of the result","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const getPageLength = webMethod(Permissions.Anyone, () => {\n return contacts.queryLabels()\n .find()\n .then((results) => {\n return results.length; // 20\n })\n .catch((error) => {\n console.error(error);\n });\n});"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current results page.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/labels-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions."},{"name":"pageSize","slug":"page-size","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the page size of a query result","content":"let resultPageSize = results.pageSize; // 50"},{"title":"Perform a query and get the page size of the result","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts } from 'wix-crm-backend';\n\nexport const getPageSize = webMethod(Permissions.Anyone, async () => {\n try {\n const results = await contacts.queryLabels().find();\n return results.pageSize; // 50\n } catch (error) {\n console.error(error);\n }\n});"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the query page size.\r\n\r\nThe page size is defined by the [`limit()`](wix-crm-backend/contacts/labels-query-builder/limit)\r\nfunction, can be retrieved using the [`pageSize`](#pageSize) property, and\r\nnavigating through pages is done with the [`prev()`](#prev) and\r\n[`next()`](#next) functions."},{"name":"query","slug":"query","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query that produced the current result","content":"let resultQuery = results.query;"},{"title":"Perform a query and get the query that produced the result","content":"import { contacts } from 'wix-crm-backend';\n\n// ...\n\nconst originalQueryResults = await contacts.queryLabels()\n .find();\n\nconst newQueryResults = await originalQueryResults.query\n .descending(\"_createdDate\")\n .find();\n\nconst firstItem = newQueryResults.items[0];"}],"type":{"kind":"REFERENCE","name":"LabelsQueryBuilder","referenceFqn":"Contacts.LabelsQueryBuilder.LabelsQueryBuilder"},"description":"Returns the `LabelsQueryBuilder` object used to get the current results.\r\n\r\nUse the `query` property to create and run a new query\r\nby chaining additional `LabelsQueryBuilder` functions to it."}]}],"builderTypes":[],"properties":[]},{"name":"Events","slug":"events","fqn":"Events","standaloneTypes":[],"metadata":{},"actions":[{"name":"onCardCreated","fqn":"Events.onCardCreated","slug":"on-card-created","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event when a card is created","content":"// Place this code in the events.js file\n// of your site's Backend section.\n\nexport function wixCrm_onCardCreated(event) {\n let workflowId = event.workflowId;\n let cardName = event.card.name;\n}\n\n/* Full event object:\n * {\n * \"workflowId\": \"f2cb00b5-9286-4d35-b41b-367d6fec43ce\",\n * \"workflowName\": \"My Workflow\",\n * \"phaseId\": \"ngp4030h-no3q-038h-c390-of40dn28pc9e\",\n * \"phaseName\": \"To-do\",\n * \"card\": {\n * \"name\": \"This is a card.\",\n * \"source\": \"Contacts\",\n * \"id\": \"gd83brj9-34n8-ce8h-fh08-4e90cni3df89\",\n * \"contactId\": \"ej8994ed-h3e9-uh2w-fhu0-vj013in3cej8\",\n * \"createdAt\": 2019-03-13T00:00:00.000Z,\n * \"updatedAt\": 2019-06-12T00:00:00.000Z\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CardCreatedEvent","referenceFqn":"Events.CardCreatedEvent"},"description":"The created card's data."}],"description":"**Deprecated.**\r\nThis event will continue to work until June 30, 2024.\r\n\r\nAn event that triggers when a new workflow card is created.\r\n\r\n The `onCardCreated()` event handler runs when a new [workflow](https://support.wix.com/en/article/about-workflows)\r\n card is created programmatically using the [`createCard()`](wix-crm-backend.Workflows.html#createCard)\r\n function or manually in your site's Dashboard. The received `CardCreatedEvent`\r\n object contains information about the card that was created.\r\n\r\n> **Note:** Backend events don't work when previewing your site.","sdkErrors":[]},{"name":"onCardMoved","fqn":"Events.onCardMoved","slug":"on-card-moved","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event when a card is moved","content":"// Place this code in the events.js file\n// of your site's Backend section.\n\nexport function wixCrm_onCardMoved(event) {\n let workflowId = event.workflowId;\n let cardName = event.card.name;\n}\n\n/* Full event object:\n * {\n * \"workflowId\": \"f2cb00b5-9286-4d35-b41b-367d6fec43ce\",\n * \"workflowName\": \"n89f2df2-2919-43jk-3uio-v90se98s5ipf\",\n * \"newPhaseId\": \"In Progress\",\n * \"newPhaseName\": \"sd98iop3-87v3-ni4u-9438-vjc9hu8ec80w\",\n * \"previousPhaseId\": \"b00831ee-cc5d-4447-81d7-2ca1828f07b2\",\n * \"previousPhaseName\": \"To-do\",\n * \"card\": {\n * \"name\": \"This is a card.\",\n * \"id\": \"gd83brj9-34n8-ce8h-fh08-4e90cni3df89\",\n * \"contactId\": \"ej8994ed-h3e9-uh2w-fhu0-vj013in3cej8\",\n * \"createdAt\": 2019-03-13T00:00:00.000Z,\n * \"updatedAt\": 2019-06-12T00:00:00.000Z\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CardMovedEvent","referenceFqn":"Events.CardMovedEvent"},"description":"The moved card's data."}],"description":"**Deprecated.**\r\nThis event will continue to work until June 30, 2024.\r\n\r\nAn event that triggers when a workflow card is moved.\r\n\r\n The `onCardMoved()` event handler runs when a [workflow](https://support.wix.com/en/article/about-workflows)\r\n card is moved programmatically using the [`moveCard()`](wix-crm-backend.Workflows.html#moveCard)\r\n function or manually in your site's Dashboard. The received `CardMovedEvent`\r\n object contains information about the card that was moved.\r\n> **Note:** Backend events don't work when previewing your site.","sdkErrors":[]},{"name":"onCardRestored","fqn":"Events.onCardRestored","slug":"on-card-restored","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event when a card is restored","content":"// Place this code in the events.js file\n// of your site's Backend section.\n\nexport function wixCrm_onCardRestored(event) {\n let workflowId = event.workflowId;\n let cardName = event.card.name;\n}\n\n/* Full event object:\n * {\n * \"workflowId\": \"f2cb00b5-9286-4d35-b41b-367d6fec43ce\",\n * \"workflowName\": \"My Workflow\",\n * \"phaseId\": \"ngp4030h-no3q-038h-c390-of40dn28pc9e\",\n * \"phaseName\": \"To-do\",\n * \"card\": {\n * \"name\": \"This is a card.\",\n * \"source\": \"Contacts\",\n * \"id\": \"gd83brj9-34n8-ce8h-fh08-4e90cni3df89\",\n * \"contactId\": \"ej8994ed-h3e9-uh2w-fhu0-vj013in3cej8\",\n * \"createdAt\": 2019-03-13T00:00:00.000Z,\n * \"updatedAt\": 2019-06-12T00:00:00.000Z\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CardRestoredEvent","referenceFqn":"Events.CardRestoredEvent"},"description":"The restored card's data."}],"description":"**Deprecated.**\r\nThis event will continue to work until June 30, 2024.\r\n\r\nAn event that triggers when a workflow card is moved.\r\n\r\n The `onCardRestored()` event handler runs when a [workflow](https://support.wix.com/en/article/about-workflows)\r\n card is restored programmatically using the [`restoreCard()`](wix-crm-backend.Workflows.html#restoreCard)\r\n function or manually in your site's Dashboard. The received `CardRestoredEvent`\r\n object contains information about the card that was restored.\r\n\r\n> **Note:** Backend events don't work when previewing your site.","sdkErrors":[]},{"name":"onContactCreated","fqn":"Events.onContactCreated","slug":"on-contact-created","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when a contact is created","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixCrm_onContactCreated(event) {\n const contactId = event.metadata.entityId;\n const contactName = `${event.entity.info?.name?.first} ${event.entity.info?.name?.last}`;\n console.log('Contact created', event);\n}\n\n/* Full event object:\n * {\n * \"metadata\": {\n * \"id\": \"fde04f82-c5e4-442e-b70e-0fd3f506f2e8\",\n * \"entityId\": \"bea905ef-d7cb-49b9-bce7-19342d3e7ab3\",\n * \"eventTime\": \"2021-02-12T00:18:03.097922Z\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"entity\": {\n * \"_id\": \"bea905ef-d7cb-49b9-bce7-19342d3e7ab3\",\n * \"_createdDate\": \"2021-02-12T00:18:03.045Z\",\n * \"_updatedDate\": \"2021-02-12T00:18:03.046Z\",\n * \"revision\": 0,\n * \"info\": {\n * \"name\": {\n * \"first\": \"Ari\",\n * \"last\": \"Thereyet\"\n * },\n * \"extendedFields\": {\n * \"contacts.displayByFirstName\": \"Ari Thereyet\",\n * \"contacts.displayByLastName\": \"Thereyet Ari\"\n * }\n * },\n * \"source\": {\n * \"wixAppId\": \"v4.createContact\"\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-02-12T00:18:03.045Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * }\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactCreatedEvent","referenceFqn":"Events.ContactCreatedEvent"},"description":"Information about the contact that was created\r\nand metadata for the event."}],"description":"An event that triggers when a new contact is created.\r\n\r\nThe `onContactCreated()` event handler runs when a new\r\n[contact](https://support.wix.com/en/article/about-your-contact-list)\r\nis created.\r\nThe received `ContactCreatedEvent` object\r\ncontains information about the contact that was created.\r\n\r\n> **Note:** Backend events don't work when previewing your site.","sdkErrors":[]},{"name":"onContactDeleted","fqn":"Events.onContactDeleted","slug":"on-contact-deleted","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when a contact is deleted","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixCrm_onContactDeleted(event) {\n const contactId = event.metadata.entityId;\n console.log('Contact deleted', event);\n}\n\n/* Full event object:\n * {\n * \"metadata\": {\n * \"id\": \"225bb629-4813-4c58-91ec-07aa5fbf069c\",\n * \"entityId\": \"ab1b7f0f-fd39-45ac-b13b-cb02c93b5e50\",\n * \"eventTime\": \"2021-02-10T19:18:03.442207Z\",\n * \"triggeredByAnonymizeRequest\": false\n * }\n * }\n */"},{"title":"Ignore a delete event if it originated from a merge","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixCrm_onContactDeleted(event) {\n\n if (event.metadata.originatedFrom === 'merge') {\n\n console.log('Contact was a source contact for a merge. Ignoring event.');\n return;\n\n } else {\n\n const deletedContactId = event.metadata.entityId;\n console.log('Contact deleted', event);\n\n // Handle the event\n\n }\n\n}\n\n/* Full event object:\n * {\n * \"metadata\": {\n * \"entityId\": \"c8e08afd-deac-40f7-b4c1-b42409d35df7\",\n * \"id\": \"1c7adeb5-c54a-4af0-8ea9-315d95cb5899\",\n * \"eventTime\": \"2022-02-02T22:05:47.361876Z\",\n * \"originatedFrom\": \"merge\",\n * \"triggeredByAnonymizeRequest\": false\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactDeletedEvent","referenceFqn":"Events.ContactDeletedEvent"},"description":"Metadata for the event."}],"description":"An event that triggers when a contact is deleted.\r\n\r\nThe `onContactDeleted()` event handler runs when a\r\n[contact](https://support.wix.com/en/article/about-your-contact-list)\r\nis deleted.\r\nThe received `ContactDeletedEvent` object\r\ncontains event metadata.\r\n\r\nIf a contact is deleted as part of a merge,\r\n`metadata.originatedFrom` is sent as `\"merge\"`.\r\nOtherwise, `originatedFrom` is omitted.\r\n\r\n> **Note:** Backend events don't work when previewing your site.","sdkErrors":[]},{"name":"onContactMerged","fqn":"Events.onContactMerged","slug":"on-contact-merged","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when contacts are merged","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixCrm_onContactMerged(event) {\n const eventId = event.metadata.id;\n const sourceContactIds = event.data.sourceContactIds;\n const firstSourceContactId = event.data.sourceContactIds[0];\n const targetContactId = event.data.targetContact._id;\n const targetContactName = `${event.data.targetContact.info?.name?.first} ${event.data.targetContact.info?.name?.last}`;\n\n console.log('Target contact updated by merge', targetContactId);\n console.log('Source contacts deleted by merge', sourceContactIds);\n}\n\n/* Full event object:\n * {\n * \"metadata\": {\n * \"id\": \"c6f09a37-8c03-469e-bfa8-9a40939cac66\",\n * \"entityId\": \"87227cf7-4ed5-47c3-8261-795d16b6dc9f\",\n * \"eventTime\": \"2022-02-02T22:05:47.278693Z\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"data\": {\n * \"sourceContactIds\": [\n * \"c8e08afd-deac-40f7-b4c1-b42409d35df7\"\n * ],\n * \"targetContactId\": \"87227cf7-4ed5-47c3-8261-795d16b6dc9f\",\n * \"targetContact\": {\n * \"_id\": \"49c5d809-6bc8-40b1-86e7-4bf3f6d17adb\",\n * \"_createdDate\": \"2022-02-02T21:41:03.306Z\",\n * \"_updatedDate\": \"2022-02-02T21:52:00.048Z\",\n * \"revision\": 6,\n * \"primaryInfo\": {\n * \"email\": \"target.contact@example.com\",\n * \"phone\": \"62183848\"\n * },\n * \"info\": {\n * \"name\": {\n * \"first\": \"Updated Target\"\n * },\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Updated Target\",\n * \"invoices.vatId\": \"\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"emailSubscriptions.effectiveEmail\": \"source.contact@example.com\",\n * \"contacts.displayByFirstName\": \"Updated Target\"\n * },\n * \"profilePicture\": \"https://img-wixmp-8be454c954980f083caba37c.wixmp.com/sites/7b940519-404c-4972-9f03-9a430b68d52c/49c5d809-6bc8-40b1-86e7-4bf3f6d17adb/ecb8b31b-845c-4bc6-b868-73df78a92313-avatar-v2.jpeg::fil:100_100\",\n * \"phones\": [\n * {\n * \"tag\": \"HOME\",\n * \"_id\": \"5a53acb4-fd19-411e-93f3-3bd7ca8f9df8\",\n * \"formattedPhone\": \"+45 62183848\",\n * \"countryCode\": \"DK\",\n * \"e164Phone\": \"+4562183848\",\n * \"primary\": true,\n * \"phone\": \"62183848\"\n * },\n * {\n * \"tag\": \"WORK\",\n * \"_id\": \"b98e5caf-95d6-4fab-b80c-267431b82344\",\n * \"formattedPhone\": \"+45 64498094\",\n * \"countryCode\": \"DK\",\n * \"e164Phone\": \"+4564498094\",\n * \"primary\": false,\n * \"phone\": \"64498094\"\n * }\n * ],\n * \"labelKeys\": [\n * \"contacts.contacted-me\"\n * ],\n * \"picture\": {\n * \"image\": \"https://img-wixmp-8be454c954980f083caba37c.wixmp.com/sites/7b940519-404c-4972-9f03-9a430b68d52c/49c5d809-6bc8-40b1-86e7-4bf3f6d17adb/ecb8b31b-845c-4bc6-b868-73df78a92313-avatar-v2.jpeg::fil:100_100\"\n * },\n * \"emails\": [\n * {\n * \"tag\": \"HOME\",\n * \"email\": \"target.contact@example.com\",\n * \"primary\": true,\n * \"_id\": \"81109065-7b9e-4b99-b146-b523eb5338ca\"\n * },\n * {\n * \"tag\": \"WORK\",\n * \"email\": \"source.contact@example.com\",\n * \"primary\": false,\n * \"_id\": \"cd9ea33c-4358-457f-bd99-4384cf5f83c2\"\n * }\n * ],\n * \"addresses\": [\n * {\n * \"_id\": \"a3455bd0-76af-427c-9adc-8d384193f347\",\n * \"tag\": \"HOME\",\n * \"address\": {\n * \"addressLine1\": \"4197 Existing Street Address\",\n * \"city\": \"Klitmøller\",\n * \"formatted\": \"4197 Existing Street Address\\nHovedstaden Klitmøller\\nDenmark\",\n * \"country\": \"DK\",\n * \"postalCode\": \"Hovedstaden\"\n * }\n * },\n * {\n * \"_id\": \"c3bb555c-a543-4e0a-86e3-341ced30666c\",\n * \"tag\": \"WORK\",\n * \"address\": {\n * \"addressLine1\": \"9278 Source Street\",\n * \"city\": \"København S\",\n * \"formatted\": \"9278 Source Street\\n31562 København S\\nDenmark\",\n * \"country\": \"DK\",\n * \"postalCode\": \"31562\",\n * \"subdivision\": \"DK-82\"\n * }\n * }\n * ]\n * },\n * \"source\": {\n * \"sourceType\": \"ADMIN\",\n * \"appId\": \"manual\"\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2022-02-02T21:51:59.952Z\",\n * \"activityType\": \"CONTACT_MERGED\"\n * }\n * }\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactMergedEvent","referenceFqn":"Events.ContactMergedEvent"},"description":"Information about the source and target contacts,\r\nand metadata for the event."}],"description":"An event that triggers when one or more source contacts are merged into a target contact.\r\n\r\nThe `onContactMerged()` event handler runs when a\r\n[contact](https://support.wix.com/en/article/about-your-contact-list)\r\nis merged.\r\nThe received `ContactMergedEvent` object\r\ncontains event metadata.\r\n\r\nMerging contacts triggers these events:\r\n\r\n- `onContactMerged()` is triggered.\r\n- [`onContactUpdated()`](#onContactUpdated) is triggered for the target contact. `metadata.originatedFrom` is sent as `\"merge\"`.\r\n- [`onContactDeleted()`](#onContactDeleted) is triggered for each source contact. `metadata.originatedFrom` is sent as `\"merge\"`.\r\n\r\nIf you handle the originating merge event,\r\nyou can ignore update and delete events where `metadata.originatedFrom` is set to `\"merge\"`.\r\nWhen `onContactUpdated()` and `onContactDeleted()` are not triggered from a merge,\r\n`originatedFrom` is omitted from their event object.\r\n\r\n> **Note:** Backend events don't work when previewing your site.","sdkErrors":[]},{"name":"onContactUpdated","fqn":"Events.onContactUpdated","slug":"on-contact-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when a contact is updated","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixCrm_onContactUpdated(event) {\n const contactId = event.metadata.entityId;\n const contactName = `${event.entity.info?.name?.first} ${event.entity.info?.name?.last}`;\n console.log('Contact updated', event);\n}\n\n/* Full event object:\n * {\n * \"metadata\": {\n * \"id\": \"74cb6d78-21c8-42a6-aa7b-e9128e1c77e6\",\n * \"entityId\": \"bc0ae72b-3285-485b-b0ad-c32c769a4daf\",\n * \"eventTime\": \"2021-04-07T21:03:39.731445Z\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"entity\": {\n * \"_id\": \"bc0ae72b-3285-485b-b0ad-c32c769a4daf\",\n * \"_createdDate\": \"2021-03-30T13:12:39.649Z\",\n * \"_updatedDate\": \"2021-04-07T21:03:39.481Z\",\n * \"revision\": 2,\n * \"primaryInfo\": {\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"phone\": \"(722)-138-3099\"\n * },\n * \"info\": {\n * \"name\": {\n * \"first\": \"Gene\",\n * \"last\": \"Lopez\"\n * },\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Lopez Gene\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"custom.event-we-met-at\": \"LegalBigData\",\n * \"emailSubscriptions.effectiveEmail\": \"gene.lopez.at.home@example.com\",\n * \"contacts.displayByFirstName\": \"Gene Lopez\"\n * },\n * \"locale\": \"en-us\",\n * \"company\": \"Borer and Sons, Attorneys at Law\",\n * \"phones\": [\n * {\n * \"tag\": \"MOBILE\",\n * \"_id\": \"820e4640-ffe0-4980-a097-62a715e73135\",\n * \"countryCode\": \"US\",\n * \"primary\": true,\n * \"phone\": \"(722)-138-3099\"\n * },\n * {\n * \"tag\": \"HOME\",\n * \"_id\": \"8506549e-e4f8-42f6-b6fc-9db155b582ef\",\n * \"countryCode\": \"US\",\n * \"e164Phone\": \"+17044541233\",\n * \"primary\": false,\n * \"phone\": \"(704)-454-1233\"\n * }\n * ],\n * \"birthdate\": \"1981-11-02\",\n * \"labelKeys\": [\n * \"contacts.contacted-me\",\n * \"custom.new-lead\"\n * ],\n * \"picture\": {\n * \"image\": \"https://randomuser.me/api/portraits/men/0.jpg\",\n * \"imageProvider\": \"EXTERNAL\"\n * },\n * \"jobTitle\": \"Senior Staff Attorney\",\n * \"emails\": [\n * {\n * \"tag\": \"HOME\",\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"primary\": true,\n * \"_id\": \"5bdcce4a-37c2-46ed-b49c-d562c6e3c4ce\"\n * },\n * {\n * \"tag\": \"WORK\",\n * \"email\": \"gene.lopez@example.com\",\n * \"primary\": false,\n * \"_id\": \"78e5f398-e148-448d-b490-7c0b7d2ab336\"\n * }\n * ],\n * \"addresses\": [\n * {\n * \"_id\": \"8532051f-91f2-42d9-9a97-9f2c39e64f7a\",\n * \"tag\": \"HOME\",\n * \"address\": {\n * \"city\": \"El Cajon\",\n * \"location\": {\n * \"latitude\": 84.1048,\n * \"longitude\": -116.8836\n * },\n * \"streetAddress\": {\n * \"number\": \"9834\",\n * \"name\": \"Bollinger Rd\"\n * },\n * \"formatted\": \"9834 Bollinger Rd\\nEl Cajon, WY 97766\\nUS\",\n * \"country\": \"US\",\n * \"postalCode\": \"97766\",\n * \"subdivision\": \"US-WY\"\n * }\n * }\n * ]\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-30T13:12:39.649Z\",\n * \"activityType\": \"CONTACT_CREATED\"\n * },\n * \"source\": {\n * \"appId\": \"v4.createContact\"\n * }\n * }\n * }\n */"},{"title":"Ignore an update event if it originated from a merge","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixCrm_onContactUpdated(event) {\n\n if (event.metadata.originatedFrom === 'merge') {\n\n console.log('Contact is a target contact for a merge. Ignoring event.');\n return;\n\n } else {\n\n const contactId = event.metadata.entityId;\n const contactName = `${event.entity.info?.name?.first} ${event.entity.info?.name?.last}`;\n console.log('Contact updated', event);\n\n // Handle the event\n\n }\n\n}\n\n/* Full event object:\n * {\n * \"metadata\": {\n * \"id\": \"74cb6d78-21c8-42a6-aa7b-e9128e1c77e6\",\n * \"entityId\": \"bc0ae72b-3285-485b-b0ad-c32c769a4daf\",\n * \"eventTime\": \"2021-04-07T21:03:39.731445Z\",\n * \"originatedFrom\": \"merge\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"entity\": {\n * \"_id\": \"bc0ae72b-3285-485b-b0ad-c32c769a4daf\",\n * \"_createdDate\": \"2021-03-30T13:12:39.649Z\",\n * \"_updatedDate\": \"2021-04-07T21:03:39.481Z\",\n * \"revision\": 2,\n * \"primaryInfo\": {\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"phone\": \"(722)-138-3099\"\n * },\n * \"info\": {\n * \"name\": {\n * \"first\": \"Gene\",\n * \"last\": \"Lopez\"\n * },\n * \"extendedFields\": {\n * \"contacts.displayByLastName\": \"Lopez Gene\",\n * \"emailSubscriptions.deliverabilityStatus\": \"NOT_SET\",\n * \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n * \"custom.event-we-met-at\": \"LegalBigData\",\n * \"emailSubscriptions.effectiveEmail\": \"gene.lopez.at.home@example.com\",\n * \"contacts.displayByFirstName\": \"Gene Lopez\"\n * },\n * \"locale\": \"en-us\",\n * \"company\": \"Borer and Sons, Attorneys at Law\",\n * \"phones\": [\n * {\n * \"tag\": \"MOBILE\",\n * \"_id\": \"820e4640-ffe0-4980-a097-62a715e73135\",\n * \"countryCode\": \"US\",\n * \"primary\": true,\n * \"phone\": \"(722)-138-3099\"\n * },\n * {\n * \"tag\": \"HOME\",\n * \"_id\": \"8506549e-e4f8-42f6-b6fc-9db155b582ef\",\n * \"countryCode\": \"US\",\n * \"e164Phone\": \"+17044541233\",\n * \"primary\": false,\n * \"phone\": \"(704)-454-1233\"\n * }\n * ],\n * \"birthdate\": \"1981-11-02\",\n * \"labelKeys\": [\n * \"contacts.contacted-me\",\n * \"custom.new-lead\"\n * ],\n * \"picture\": {\n * \"image\": \"https://randomuser.me/api/portraits/men/0.jpg\",\n * \"imageProvider\": \"EXTERNAL\"\n * },\n * \"jobTitle\": \"Senior Staff Attorney\",\n * \"emails\": [\n * {\n * \"tag\": \"HOME\",\n * \"email\": \"gene.lopez.at.home@example.com\",\n * \"primary\": true,\n * \"_id\": \"5bdcce4a-37c2-46ed-b49c-d562c6e3c4ce\"\n * },\n * {\n * \"tag\": \"WORK\",\n * \"email\": \"gene.lopez@example.com\",\n * \"primary\": false,\n * \"_id\": \"78e5f398-e148-448d-b490-7c0b7d2ab336\"\n * }\n * ],\n * \"addresses\": [\n * {\n * \"_id\": \"8532051f-91f2-42d9-9a97-9f2c39e64f7a\",\n * \"tag\": \"HOME\",\n * \"address\": {\n * \"city\": \"El Cajon\",\n * \"location\": {\n * \"latitude\": 84.1048,\n * \"longitude\": -116.8836\n * },\n * \"streetAddress\": {\n * \"number\": \"9834\",\n * \"name\": \"Bollinger Rd\"\n * },\n * \"formatted\": \"9834 Bollinger Rd\\nEl Cajon, WY 97766\\nUS\",\n * \"country\": \"US\",\n * \"postalCode\": \"97766\",\n * \"subdivision\": \"US-WY\"\n * }\n * }\n * ]\n * },\n * \"lastActivity\": {\n * \"activityDate\": \"2021-03-30T13:12:39.649Z\",\n * \"activityType\": \"CONTACT_MERGED\"\n * },\n * \"source\": {\n * \"appId\": \"v4.createContact\"\n * }\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactUpdatedEvent","referenceFqn":"Events.ContactUpdatedEvent"},"description":"Information about the contact that was updated\r\nand metadata for the event."}],"description":"An event that triggers when a contact is updated.\r\n\r\nThe `onContactUpdated()` event handler runs when a\r\n[contact](https://support.wix.com/en/article/about-your-contact-list)\r\nis updated.\r\nThe received `ContactUpdatedEvent` object\r\ncontains information about the contact that was updated.\r\n\r\nIf a contact is updated as part of a merge,\r\n`metadata.originatedFrom` is sent as `\"merge\"`.\r\nOtherwise, `originatedFrom` is omitted.\r\n\r\n> **Note:** Backend events don't work when previewing your site.","sdkErrors":[]},{"name":"onFormSubmit","fqn":"Events.onFormSubmit","slug":"on-form-submit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["event"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event when a Wix Form is submitted","content":"// Place this code in the events.js file\n// of your site's Backend section.\n\nexport function wixCrm_onFormSubmit(event) {\n let formName = event.formName;\n}\n\n/* Full event object:\n * {\n * \"contactId\": \"f2cb00b5-9286-4d35-b41b-367d6fec43ce\",\n * \"formName\": \"Feedback Form\",\n * \"submissionTime\": \"2019-03-24T12:58:20.617Z\",\n * \"submissionData\": [\n * {\n * \"fieldName\": \"First Name\",\n * \"fieldValue\": \"John\"\n * },\n * {\n * \"fieldName\": \"Last Name\",\n * \"fieldValue\": \"Doe\"\n * },\n * {\n * \"fieldName\": \"Email\",\n * \"fieldValue\": \"john.doe@somedomain.com\"\n * }\n * ],\n * \"attachments\": [\n * {\n * \"name\": \"flowers.jpg\",\n * \"type\": \"IMAGE\",\n * \"url\": \"wix:image://v1/68d3a9_1de7529c444b4c9eb38401f8efe0cad2.jpg/flowers.jpg#originWidth=1970&originHeight=112\"\n * },\n * {\n * \"name\": \"SampleVideo_1280x720_10mb.mp4\",\n * \"type\": \"VIDEO\",\n * \"url\": \"wix:video://v1/80c05f_be1c421575e34915ad257571c4055ee4/SampleVideo_1280x720_10mb.mp4\"\n * }\n * ]\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FormSubmitEvent","referenceFqn":"Events.FormSubmitEvent"},"description":"The Wix Form data."}],"description":"An event that triggers when a site visitor submits a Wix Form.\r\n\r\nThe `onFormSubmit()` event handler runs when a site visitor submits a Wix Form (see the [`WixForms`](https://dev.wix.com/docs/velo/api-reference/$w/form/introduction) `$w` element). \r\n\r\n The received `FormSubmitEvent` object contains information about the Wix Form that was submitted.\r\n > **Note:** Backend events don't work when previewing your site.\r\n\r\n For Wix Forms client side events, see: \r\n\r\n + The [`onWixFormSubmit()`](https://dev.wix.com/docs/velo/api-reference/$w/wix-forms/on-wix-form-submit) function, which sets events that fire when a site visitor submits a Wix Form yet before it is sent to the server. \r\n + The [`onWixFormSubmitted()`](https://dev.wix.com/docs/velo/api-reference/$w/wix-forms/on-wix-form-submitted) function, which sets events that fire when a site visitor submits a Wix Form and it is successfully received by the server. \r\n + The [`onWixFormSubmittedError()`](https://dev.wix.com/docs/velo/api-reference/$w/wix-forms/on-wix-form-submitted-error) function, which sets events that fire when a site visitor submits a Wix Form and it is successfully received by the server.","sdkErrors":[]}],"webhooks":[],"articles":[{"content":"# Introduction\nWix CRM events are fired on your site's backend when certain events occur related to site contacts.\n You can write event handlers that react to these events. Event handler functions\n receive data that corresponds to the event that fired. Use event handlers\n to create custom responses to contact events.\n\n To add a CRM event handler, add an **events.js** file to the **Backend** section\n of your site if one does not already exist. All event handler functions for your\n site are defined in this file.\n\n Event handler functions are defined using the following pattern:\n\n ```javascript\n export function _(event) { }\n ```\n\n For example, an event handler that handles site visitor form submittal looks\n like this:\n\n ```javascript\n export function wixCrm_onFormSubmit(event) { }\n ```\n\n Note that backend events don't work when previewing your site.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"Notifications","slug":"notifications","fqn":"Notifications","standaloneTypes":[],"metadata":{},"actions":[{"name":"notify","fqn":"Notifications.notify","slug":"notify","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["body","channels"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the send notification request is received."},"examples":[{"title":"Send a notification to the site owner's Dashboard","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { notifications } from 'wix-crm-backend';\n\nexport const notifyOwnerOnDashboard = webMethod(Permissions.Anyone, () => {\n notifications.notify(\n \"Notification body\",\n [\"Dashboard\"],\n {\n \"title\": \"Notification Title\",\n \"actionTitle\": \"Click this!\",\n \"actionTarget\": { \"url\": \"http://mysite.com/somepage\" },\n \"recipients\": { \"role\": \"Owner\" }\n }\n );\n});"},{"title":"Send a notification to the site owner on multiple channels (browser and mobile)","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { notifications } from 'wix-crm-backend';\n\nexport const notifyMultipleChannels = webMethod(Permissions.Anyone, () => {\n notifications.notify(\n \"Notification body\",\n [\"Browser\", \"Mobile\"],\n {\n \"title\": \"Notification Title\",\n \"actionTitle\": \"Click this!\",\n \"actionTarget\": { \"url\": \"http://mysite.com/somepage\" },\n \"recipients\": { \"role\": \"Owner\" }\n }\n );\n});"},{"title":"Send a notification to all site contributors on mobile","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { notifications } from 'wix-crm-backend';\n\nexport const notifySiteContributors = webMethod(Permissions.Anyone, () => {\n notifications.notify(\n \"Notification body\", \n [\"Mobile\"], \n {\n \"title\": \"Notification Title\",\n \"actionTitle\": \"Click this!\",\n \"actionTarget\": {\"url\": \"http://mysite.com/somepage\"},\n \"recipients\": { \"role\": \"All_Contributors\"}\n }\n );\n});"}],"actionParams":[{"name":"body","slug":"body","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contents of the notification. Max length: 512 characters."},{"name":"channels","slug":"channels","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"The channels to send the notification on. \r\nOne or more of: \r\n\r\n+ `\"Mobile\"`: Sends the notification to the Wix App.\r\n+ `\"Dashboard\"`: Sends the notification to the contributor's Wix dashboard.\r\n+ `\"Browser\"`: Sends the notification to the contributor's browser."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"NotificationOptions","referenceFqn":"Notifications.NotificationOptions"},"description":"Additional notification related information."}],"description":"Sends a notification.\r\n\r\nThe `notify()` function sends a [notification](https://support.wix.com/en/article/about-site-notifications) to\r\n the specified site contributors on the specified channels.\r\n\r\n Use the `channels` parameter to specify which channels to send the notification to.\r\n\r\n Use the `recipients` property of the `options` parameter to specify which site\r\n contributors to send the notification to.","sdkErrors":[]}],"webhooks":[],"articles":[{"content":"# Introduction\nNotifications are messages that are sent to the site dashboard, Wix app,\n and/or browser of your site's [contributors](https://support.wix.com/en/article/roles-permissions-information-for-site-collaborators).\n\n To learn more about notifications, see [About Site Notifications](https://support.wix.com/en/article/about-site-notifications).\n\n To use the Notifications API, import `notifications` from the `wix-crm-backend` module:\n\n ```javascript\n import {notifications} from 'wix-crm-backend';\n ```","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"Tasks","slug":"tasks","fqn":"Tasks","standaloneTypes":[],"metadata":{},"actions":[{"name":"completeTask","fqn":"Tasks.completeTask","slug":"complete-task","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["taskId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfilled - ID of the task to set as complete."},"examples":[{"title":"Set a task as completed","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { tasks } from 'wix-crm-backend';\n\nexport const completeTask = webMethod(Permissions.Anyone, (taskId) => {\n return tasks.completeTask(taskId);\n});\n\n// Returns a promise that resolves to:\n// \"3c9683ea-f6cc-470b-b0d1-2eb6b8cea912\""}],"actionParams":[{"name":"taskId","slug":"task-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the task to set as complete."}],"description":"**Deprecated.**\r\nThis function is deprecated but will continue to work. \r\nTo set a task as completed, see the [wix-crm.v2.Tasks.updateTask()](https://www.wix.com/velo/reference/wix-crm-v2/tasks/updatetask) function.\r\n\r\n* > #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-crm.v2.Tasks.updateTask()`](https://www.wix.com/velo/reference/wix-crm-v2/tasks/updatetask).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { tasks } from 'wix-crm.v2'\r\n> ```\r\n>\r\n> 2. If you plan to migrate all functions that use `wixCrmBackend`,\r\n> remove the original `import wixCrmBackend` statement.\r\n>\r\n> 3. Look for any code that uses `wixCrmBackend.tasks.removeTask()`,\r\n> and replace it with with `tasks.updateTask()`. To set the task as completed, \r\n> set the `status` field to `\"COMPLETED\"`.\r\n>\r\n> 4. Test your changes to make sure your code behaves as expected.\r\n\r\n\r\nSets a task as completed.\r\n\r\n The `completeTask()` function returns a Promise that resolves to the ID of the\r\n the task after it is set as completed.","sdkErrors":[]},{"name":"createTask","fqn":"Tasks.createTask","slug":"create-task","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["taskInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfilled - ID of the newly created task."},"examples":[{"title":"Create a new task","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { tasks } from 'wix-crm-backend';\n\nexport const createTask = webMethod(Permissions.Anyone, (title, contactId, dueDate) => {\n const taskInfo = {\n \"title\": title,\n \"contactId\": contactId,\n \"dueDate\": dueDate\n };\n\n return tasks.createTask(taskInfo);\n});\n\n// Returns promise that resolves to:\n// 3c9683ea-f6cc-470b-b0d1-2eb6b8cea912"},{"title":"Create a new task on button click","description":"This example demonstrates how to create a task to follow up with the current\n user in a month's time when the user clicks a Follow Up button.","content":"/****************************\n * Backend code - tasks.web.js *\n ****************************/\nimport { Permissions, webMethod } from 'wix-web-module';\nimport { tasks } from 'wix-crm-backend';\nimport wixUsers from 'wix-users-backend';\n\nexport const createFollowUpTask = webMethod(Permissions.Anyone, () => {\n let followUpDate = new Date();\n followUpDate.setMonth(followUpDate.getMonth() + 1);\n\n const taskInfo = {\n \"title\": \"Follow Up\",\n \"contactId\": wixUsers.currentUser.id,\n \"dueDate\": followUpDate\n };\n\n return tasks.createTask(taskInfo);\n});\n\n/*************\n * page code *\n *************/\nimport { createFollowUpTask } from 'backend/tasks.web';\n\n// ..\n\nexport function followUpButton_click(event) {\n createFollowUpTask()\n .then((result) => {\n console.log(result); // \"3c9683ea-f6cc-470b-b0d1-2eb6b8cea912\"\n })\n .catch((error) => {\n console.log(error);\n });\n}"}],"actionParams":[{"name":"taskInfo","slug":"task-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TaskInfo","referenceFqn":"Tasks.TaskInfo"},"description":"The information to use when creating the task."}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is \r\navailable at [wix-crm.v2.Tasks.createTask()](https://www.wix.com/velo/reference/wix-crm-v2/tasks/createtask).\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-crm.v2.Tasks.createTask()`](https://www.wix.com/velo/reference/wix-crm-v2/tasks/createtask).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { tasks } from 'wix-crm.v2'\r\n> ```\r\n>\r\n> 2. If you plan to migrate all functions that use `wixCrmBackend`,\r\n> remove the original `import wixCrmBackend` statement.\r\n>\r\n> 3. Look for any code that uses `wixCrmBackend.tasks.createTask()`,\r\n> and replace it with with `tasks.createTask()`.\r\n> Update your code to work with the new `createTask()`\r\n> call and response properties.\r\n>\r\n> 4. Test your changes to make sure your code behaves as expected.\r\n\r\nCreates a new task.\r\n\r\n The `createTask()` function returns a Promise that resolves to the ID of the\r\n the newly created task after it has been successfully created.\r\n\r\n When creating a new task, the specified `TaskInfo` object must\r\n contain a `title` value.","sdkErrors":[]},{"name":"getTask","fqn":"Tasks.getTask","slug":"get-task","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["taskId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Task","referenceFqn":"Tasks.Task"},"description":"Fulfilled - The task with the given ID."},"examples":[{"title":"Get a task by ID","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { tasks } from 'wix-crm-backend';\n\nexport const getTask = webMethod(Permissions.Anyone, (taskId) => {\n return tasks.getTask(taskId);\n});\n\n/* Returns a promise that resolves to:\n * {\n * \"_id\": \"6cb91509-7aa1-479b-a242-7327f58b7157\",\n * \"title\": \"Add domain\",\n * \"version\": 9,\n * \"dueDate\": \"2019-01-22T10:00:00Z\",\n * \"contactId\": \"6cb91509-7aa1-479b-a242-7327f58b7157\",\n * \"isCompleted\": false,\n * \"applicationId: \"791f5e4f-5377-47a9-bd8e-cc0ef4605c8f\",\n * \"creatorType\": \"APP\"\n * }\n */"}],"actionParams":[{"name":"taskId","slug":"task-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the task to get from the task list."}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is \r\navailable at [wix-crm.v2.Tasks.getTask()](https://www.wix.com/velo/reference/wix-crm-v2/tasks/gettask).\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-crm.v2.Tasks.getTask()`](https://www.wix.com/velo/reference/wix-crm-v2/tasks/gettask).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { tasks } from 'wix-crm.v2'\r\n> ```\r\n>\r\n> 2. If you plan to migrate all functions that use `wixCrmBackend`,\r\n> remove the original `import wixCrmBackend` statement.\r\n>\r\n> 3. Look for any code that uses `wixCrmBackend.tasks.getTask()`,\r\n> and replace it with with `tasks.getTask()`.\r\n> Update your code to work with the new `getTask()`\r\n> call and response properties.\r\n>\r\n> 4. Test your changes to make sure your code behaves as expected.\r\n\r\nGets a task by ID.\r\n\r\n The `getTask()` function returns a Promise that resolves to the task with the\r\n given ID.","sdkErrors":[]},{"name":"removeTask","fqn":"Tasks.removeTask","slug":"remove-task","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["taskId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfilled - ID of the removed task."},"examples":[{"title":"Remove a task","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { tasks } from 'wix-crm-backend';\n\nexport const removeTask = webMethod(Permissions.Anyone, (taskId) => {\n return tasks.removeTask(taskId);\n});\n\n// 3c9683ea-f6cc-470b-b0d1-2eb6b8cea912 - removed task id"}],"actionParams":[{"name":"taskId","slug":"task-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the task to remove."}],"description":"This function will continue to work, but a newer version is \r\navailable at [wix-crm.v2.Tasks.deleteTask()](https://www.wix.com/velo/reference/wix-crm-v2/tasks/deletetask).\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-crm.v2.Tasks.deleteTask()`](https://www.wix.com/velo/reference/wix-crm-v2/tasks/deletetask).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { tasks } from 'wix-crm.v2'\r\n> ```\r\n>\r\n> 2. If you plan to migrate all functions that use `wixCrmBackend`,\r\n> remove the original `import wixCrmBackend` statement.\r\n>\r\n> 3. Look for any code that uses `wixCrmBackend.tasks.removeTask()`,\r\n> and replace it with with `tasks.deleteTask()`.\r\n> Update your code to work with the new `deleteTask()`\r\n> call and response properties.\r\n>\r\n> 4. Test your changes to make sure your code behaves as expected.\r\n\r\nRemoves an existing task.\r\n\r\n The `removeTask()` function returns a Promise that resolves to the ID of the\r\n the removed task after it has been successfully removed.","sdkErrors":[]},{"name":"resetTask","fqn":"Tasks.resetTask","slug":"reset-task","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["taskId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfilled - ID of the task to set as not completed."},"examples":[{"title":"Reset a task as not completed","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { tasks } from 'wix-crm-backend';\n\nexport const resetTask = webMethod(Permissions.Anyone, (taskId) => {\n return tasks.resetTask(taskId);\n});\n\n// Returns a promise that resolves to:\n// \"3c9683ea-f6cc-470b-b0d1-2eb6b8cea912\""}],"actionParams":[{"name":"taskId","slug":"task-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the task to reset."}],"description":"**Deprecated.**\r\nThis function is deprecated but will continue to work. \r\nTo reset a task, see the [wix-crm.v2.Tasks.updateTask()](https://www.wix.com/velo/reference/wix-crm-v2/tasks/updatetask) function.\r\n\r\n* > #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-crm.v2.Tasks.updateTask()`](https://www.wix.com/velo/reference/wix-crm-v2/tasks/updatetask).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { tasks } from 'wix-crm.v2'\r\n> ```\r\n>\r\n> 2. If you plan to migrate all functions that use `wixCrmBackend`,\r\n> remove the original `import wixCrmBackend` statement.\r\n>\r\n> 3. Look for any code that uses `wixCrmBackend.tasks.removeTask()`,\r\n> and replace it with with `tasks.updateTask()`. To reset the task, \r\n> set the `status` field to `\"ACTION_NEEDED\"`.\r\n>\r\n> 4. Test your changes to make sure your code behaves as expected.\r\n\r\nResets a task as not completed.\r\n\r\n The `resetTask()` function returns a Promise that resolves to the ID of the\r\n the task after it is reset as not completed.","sdkErrors":[]},{"name":"updateTaskFields","fqn":"Tasks.updateTaskFields","slug":"update-task-fields","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["taskId","taskInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfilled - ID of the updated task."},"examples":[{"title":"Update a task","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { tasks } from 'wix-crm-backend';\n\nexport const updateTaskFields = webMethod(Permissions.Anyone, (taskId, taskInfo) => {\n return tasks.updateTaskFields(taskId, taskInfo);\n});\n\n// Returns a promise that resolves to:\n// \"3c9683ea-f6cc-470b-b0d1-2eb6b8cea912\""},{"title":"Update some of a task's info","description":"This example demonstrates how to update only the due date of a given task to a month from today,\n while leaving the rest of the task's information as it was before the update.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { tasks } from 'wix-crm-backend';\n\nexport const updateTaskOneMonth = webMethod(Permissions.Anyone, (taskId) => {\n let date = new Date();\n date.setMonth(date.getMonth() + 1);\n\n const taskInfo = {\n \"dueDate\": date\n };\n\n return tasks.updateTaskFields(taskId, taskInfo);\n});\n\n// Returns a promise that resolves to:\n// \"3c9683ea-f6cc-470b-b0d1-2eb6b8cea912\""},{"title":"Update some of a task's info and delete some info","description":"This example demonstrates how to delete a task's due date and contact information,\n while updating its title.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { tasks } from 'wix-crm-backend';\n\nexport const updateTitle = webMethod(Permissions.Anyone, (taskId, newTitle) => {\n const taskInfo = {\n \"title\": newTitle,\n \"dueDate\": null,\n \"contactId\": null\n };\n\n return tasks.updateTaskFields(taskId, taskInfo);\n});\n\n// Returns a promise that resolves to:\n// \"3c9683ea-f6cc-470b-b0d1-2eb6b8cea912\""}],"actionParams":[{"name":"taskId","slug":"task-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the task to update."},{"name":"taskInfo","slug":"task-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TaskInfo","referenceFqn":"Tasks.TaskInfo"},"description":"The information to update the task with."}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is \r\navailable at [wix-crm.v2.Tasks.updateTask()](https://www.wix.com/velo/reference/wix-crm-v2/tasks/updatetask).\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-crm.v2.Tasks.updateTask()`](https://www.wix.com/velo/reference/wix-crm-v2/tasks/updatetask).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { tasks } from 'wix-crm.v2'\r\n> ```\r\n>\r\n> 2. If you plan to migrate all functions that use `wixCrmBackend`,\r\n> remove the original `import wixCrmBackend` statement.\r\n>\r\n> 3. Look for any code that uses `wixCrmBackend.tasks.updateTaskFields()`,\r\n> and replace it with with `tasks.updateTask()`.\r\n> Update your code to work with the new `updateTask()`\r\n> call and response properties.\r\n>\r\n> 4. Test your changes to make sure your code behaves as expected.\r\n\r\nUpdates the specified fields of an existing task.\r\n\r\n The `updateTaskFields()` function returns a Promise that resolves to the ID of the\r\n the updated task after it has been successfully updated.\r\n\r\n Only the properties passed in the `TaskInfo` object will\r\n be updated. All other properties will remain the same.\r\n\r\n To remove a value from the task, pass its corresponding property with a value\r\n of `null`.","sdkErrors":[]}],"webhooks":[],"articles":[{"content":"# Introduction\n> **Note:**\n> The Tasks submodule is deprecated.\n> If you're already using this module in your code, it will continue to work.\n> To stay compatible with future changes, update your code\n> with the migration instructions in this module's functions.\n\n The Tasks API is used to manage a site's tasks.\n\n Use [tasks](https://support.wix.com/en/article/about-tasks-reminders) to\n organize and prioritize your work with [Ascend by Wix](https://support.wix.com/en/article/about-ascend-by-wix).\n\n To use the Tasks API, import `tasks` from the `wix-crm-backend` module:\n\n ```javascript\n import { tasks } from 'wix-crm-backend';\n ```","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"TriggeredEmails","slug":"triggered-emails","fqn":"TriggeredEmails","standaloneTypes":[],"metadata":{},"actions":[{"name":"emailContact","fqn":"TriggeredEmails.emailContact","slug":"email-contact","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["emailId","contactId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the email is sent.\r\nRejected - Error message."},"examples":[{"title":"Send a triggered email to a contact","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { triggeredEmails } from 'wix-crm-backend';\n\nexport const myEmailContactFunction = webMethod(Permissions.Anyone, (emailId, contactId) => {\n return triggeredEmails.emailContact(emailId, contactId)\n .then(() => {\n console.log('Email was sent to contact');\n })\n .catch((error) => {\n console.error(error);\n });\n});"},{"title":"Send a triggered email with variable values","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { triggeredEmails } from 'wix-crm-backend';\n\nexport const myEmailContactFunction = webMethod(Permissions.Anyone, (emailId, contactId, options) => {\n return triggeredEmails.emailContact(emailId, contactId, options)\n .then(() => {\n console.log('Email was sent to contact');\n })\n .catch((error) => {\n console.error(error);\n });\n});"},{"title":"Query for a contact and then email the contact","description":"You can use [`queryContacts()`](wix-crm-backend/contacts/querycontacts)\nto find a contact with specified details, and then extract the contact's ID.\nWith the contact ID, you can use `emailContact()`\nto send a triggered email.","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { contacts, triggeredEmails } from 'wix-crm-backend';\n\nexport const sendEmailToContact = webMethod(Permissions.Anyone, async (emailToFind) => {\n let contactId;\n const queryResults = await contacts.queryContacts()\n .eq('info.emails.email', emailToFind)\n .find();\n const contactsWithEmail = queryResults.items;\n\n if (contactsWithEmail.length === 1) {\n console.log('Found 1 contact');\n contactId = contactsWithEmail[0]._id;\n } else if (contactsWithEmail.length > 1) {\n console.log('Found more than 1 contact');\n // Handle when more than one contact is found\n } else {\n console.log('No contacts found');\n // Handle when no contacts are found\n }\n\n const triggeredEmailTemplate = 'welcome_email';\n\n try {\n await triggeredEmails.emailContact(triggeredEmailTemplate, contactId);\n console.log('Email sent to contact');\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n});"}],"actionParams":[{"name":"emailId","slug":"email-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email ID of the\r\n[triggered email](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Ftransactional-emails)\r\nto send."},{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the contact to send the email to."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TriggeredEmailOptions","referenceFqn":"TriggeredEmails.TriggeredEmailOptions"},"description":"Variable values to insert into the email."}],"description":"Sends a triggered email to a contact, unless that contact is marked as unsubscribed..\r\n\r\nThe `emailContact()` function returns a Promise\r\nthat resolves when the triggered email is sent to the contact.\r\n\r\n> **Note:**\r\n> This function replaces the deprecated\r\n> `wix-crm-backend.emailContact()`.\r\n> The deprecated function will continue to work, but it will not receive updates.\r\n> To keep any existing code compatible with future changes, see the\r\n> [migration instructions](https://dev.wix.com/docs/velo/api-reference/wix-crm-backend/email-contact).\r\n\r\n To learn more about triggered emails, see:\r\n\r\n - [About Triggered Emails](https://support.wix.com/en/article/about-triggered-emails)\r\n - [Creating a Triggered Email](https://support.wix.com/en/article/creating-a-triggered-email)\r\n - [How to Send a Triggered Email to Contacts with Code](https://support.wix.com/en/article/velo-tutorial-sending-a-triggered-email-to-contacts)\r\n\r\n Before using the `emailContact()` function, you must set up at least 1\r\n triggered email.\r\n\r\n Specify which email to send by passing the email's ID in the `emailId` parameter.\r\n\r\n Specify which contact the email is sent to by passing a contact's ID in the `contactId`\r\n parameter. To receive the email, the contact must be subscribed or marked as 'subscription not set'.\r\n If the contact is marked as unsubscribed, the email will not be sent.\r\n Read more about how to check the contact's [subscription status](https://www.wix.com/velo/reference/wix-crm-backend/contacts/querycontacts#wix-crm-backend_contacts_querycontacts_supported-query-filters-for-extended-fields).\r\n\r\n If the specified triggered email contains variables,\r\n you can pass values for those variables using the optional `options` parameter.\r\n You pass a `variables` object\r\n which contains the values to be inserted into your email in place of the variables\r\n defined in that email. The values passed must be strings. If `variables`\r\n does not contain a `key:value` pair for a\r\n variable in your triggered email, the fallback value defined when creating\r\n your triggered email is inserted in place of the variable.\r\n\r\n > __Notes:__\r\n > + The statistics for Triggered Emails are based on every time an email is sent,\r\n > including test emails that you send to yourself.\r\n > This is different from the \r\n > [statistics for Email Marketing](https://support.wix.com/en/article/viewing-your-email-marketing-statistics) \r\n > that are based on emails sent to unique contacts. Therefore, the statistics for Triggered \r\n > Emails may seem inflated compared to Email Marketing statistics.\r\n > + Triggered Emails generates a code snippet for each of your email\r\n > templates. The generated code includes the email's ID and keys for all the\r\n > email's variable names. You can copy and paste the snippet into your code.\r\n > Then, you need to define values for the `memberId` property and for each\r\n > variable key. To learn how to use the generated snippet in your code, see\r\n > [How to Send a Triggered Email with Code](https://support.wix.com/en/article/how-to-send-a-triggered-email-with-code).","sdkErrors":[]},{"name":"emailMember","fqn":"TriggeredEmails.emailMember","slug":"email-member","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["emailId","memberId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the email is sent.\r\nRejected - Error message."},"examples":[{"title":"Send a triggered email to a member","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { triggeredEmails } from 'wix-crm-backend';\n\nexport const myEmailMemberFunction = webMethod(Permissions.Anyone, () => {\n const emailId = \"thanks_for_joining\";\n const memberId = \"78ad23e2-fd34-5a14-9807-d8c2485d1f36\";\n const options = {\n variables: {\n firstName: \"Jane\",\n lastName: \"Member\"\n }\n }\n\n return triggeredEmails.emailMember(emailId, memberId, options)\n .then(() => {\n console.log(\"Email was sent to member\");\n })\n .catch((error) => {\n console.error(error);\n });\n});"}],"actionParams":[{"name":"emailId","slug":"email-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email ID of the\r\n[triggered email](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Ftransactional-emails)\r\nto send."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the member to send the email to."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TriggeredEmailOptions","referenceFqn":"TriggeredEmails.TriggeredEmailOptions"},"description":"Variable values to insert into the email."}],"description":"Sends a triggered email to a site member.\r\n\r\nThe `emailMember()` function returns a Promise\r\nthat resolves when the triggered email is sent to the specified site member.\r\n\r\n> **Note:**\r\n> This function replaces the deprecated\r\n> `wixUsersBackend.emailUser()`.\r\n> The deprecated function will continue to work, but it will not receive updates.\r\n\r\n To learn more about triggered emails, see:\r\n\r\n - [About Triggered Emails](https://support.wix.com/en/article/about-triggered-emails)\r\n - [Creating a Triggered Email](https://support.wix.com/en/article/creating-a-triggered-email)\r\n - [How to Send a Triggered Email to Members with Code](https://support.wix.com/en/article/how-to-send-a-triggered-email-to-members-with-code)\r\n\r\n Before using the `emailMember()` function, you need to set up at least 1\r\n triggered email.\r\n\r\n Specify which email to send by passing the email's ID in the `emailId` parameter.\r\n\r\n Specify which member the email is sent to by passing the member's ID in the `memberId`\r\n parameter.\r\n\r\n If the specified triggered email contains\r\n variables,\r\n you can pass values for those variables using the optional `options` parameter.\r\n You pass a `variables` object\r\n which contains the values to be inserted into your email in place of the variables\r\n defined in that email. The values passed must be strings. If `variables`\r\n does not contain a `key:value` pair for a\r\n variable in your triggered email, the fallback value defined when creating\r\n your triggered email is inserted in place of the variable.\r\n\r\n > __Notes:__\r\n > + The statistics for Triggered Emails are based on every time an email is sent,\r\n > including test emails that you send to yourself.\r\n > This is different from the \r\n > [statistics for Email Marketing](https://support.wix.com/en/article/viewing-your-email-marketing-statistics) \r\n > that are based on emails sent to unique contacts. Therefore, the statistics for Triggered \r\n > Emails may seem inflated compared to Email Marketing statistics.\r\n > + Triggered Emails generates a code snippet for each of your email\r\n > templates. The generated code includes the email's ID and keys for all the\r\n > email's variable names. You can copy and paste the snippet into your code.\r\n > Then, you need to define values for the `memberId` property and for each\r\n > variable key. To learn how to use the generated snippet in your code, see\r\n > [How to Send a Triggered Email with Code](https://support.wix.com/en/article/how-to-send-a-triggered-email-with-code).","sdkErrors":[]}],"webhooks":[],"articles":[{"content":"# Introduction\nTo learn more about Triggered Emails, see:\n\n - [About Triggered Emails](https://support.wix.com/en/article/about-triggered-emails)\n - [Creating a Triggered Email](https://support.wix.com/en/article/creating-a-triggered-email)\n - [How to Send a Triggered Email to Contacts with Code](https://support.wix.com/en/article/how-to-send-a-triggered-email-to-contacts-with-code)\n\nBefore using `emailContact()` or `emailMember()`, you must set up at least 1 Triggered Email.\n\n> __Notes:__ \n>\n> Triggered Emails are included in the Email Marketing quota. However, similar to automations, \n> Triggered Emails will continue to be sent without interruption even if you reach your quota.\n>\n> The statistics for Triggered Emails are based on every time an email is sent,\n> including test emails that you send to yourself.\n> This is different from the \n> [statistics for Email Marketing](https://support.wix.com/en/article/viewing-your-email-marketing-statistics) \n> that are based on emails sent to unique contacts. Therefore, the statistics for Triggered \n> Emails may seem inflated compared to Email Marketing statistics.","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"Workflows","slug":"workflows","fqn":"Workflows","standaloneTypes":[],"metadata":{},"actions":[{"name":"archiveCard","fqn":"Workflows.archiveCard","slug":"archive-card","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["cardId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the card has been archived."},"examples":[{"title":"Archive a card","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const archiveCard = webMethod(Permissions.Anyone, (cardId) => {\n return workflows.archiveCard(cardId);\n});\n\n// Returns a promise that resolves to void."}],"actionParams":[{"name":"cardId","slug":"card-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the card to archive."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nArchives a workflow card.\r\n\r\n The `archiveCard()` function returns a Promise that resolves when the\r\n card has been archived.\r\n\r\n This function requires you to specify the ID of a card. To learn about\r\n retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]},{"name":"createCard","fqn":"Workflows.createCard","slug":"create-card","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["workflowId","phaseId","card"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfilled - ID of the newly created card."},"examples":[{"title":"Create a card","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const createCard = webMethod(Permissions.Anyone, (workflowId, phaseId, contactId, position = undefined) => {\n return workflows.createCard(\n workflowId,\n phaseId,\n {\n \"name\": \"Card Name\",\n \"contactId\": contactId\n },\n position\n );\n});\n\n// Returns a promise that resolves to:\n// \"3c9683ea-f6cc-470b-b0d1-2eb6b8cea912\""}],"actionParams":[{"name":"workflowId","slug":"workflow-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the workflow to create the card in."},{"name":"phaseId","slug":"phase-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the phase to create the card in."},{"name":"card","slug":"card","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CreateCardRequest","referenceFqn":"Workflows.CreateCardRequest"},"description":"Card to create."},{"name":"position","slug":"position","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The created card's position within the workflow."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nCreates a new workflow card.\r\n\r\n The `createCard()` function returns a Promise that resolves to the created card's\r\n ID when the card is created in the specified workflow phase.\r\n\r\n Pass a value for the `position` parameter to specify the newly created card's\r\n position within the specified phase. Positions are zero-based, meaning the first position is`0`.\r\n When omitted, the newly created card is added to the specified phase as the top card within the phase.\r\n\r\n This function requires you to specify the ID of a workflow and phase. To learn about\r\n retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).\r\n\r\n> **Note:**\r\n> Each workflow is limited to 5,000 cards.\r\n> If this limit is reached, `createCard()` throws an error.\r\n> [Archive cards](#archivecard) when they're no longer needed\r\n> to reduce card count and avoid hitting the limit.","sdkErrors":[]},{"name":"createPhase","fqn":"Workflows.createPhase","slug":"create-phase","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["workflowId","phaseInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfilled - ID of the newly created phase."},"examples":[{"title":"Create a phase","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const createPhase = webMethod(Permissions.Anyone, (workflowId, phaseInfo, position) => {\n return workflows.createPhase(\n workflowId,\n {\n \"name\": \"Phase Name\"\n },\n position\n );\n});\n\n// Returns a promise that resolves to:\n// \"3c9683ea-f6cc-470b-b0d1-2eb6b8cea912\""}],"actionParams":[{"name":"workflowId","slug":"workflow-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the workflow to add the new phase to."},{"name":"phaseInfo","slug":"phase-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CreatePhaseRequest","referenceFqn":"Workflows.CreatePhaseRequest"},"description":"Phase to create."},{"name":"position","slug":"position","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The created phase's position within the workflow."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nCreates a new workflow phase.\r\n\r\n The `createPhase()` function returns a Promise that resolves to the created phase\r\n ID when the phase is created in the specified workflow.\r\n\r\n Pass a value for the `position` parameter to specify the newly created phase's\r\n position within the specified workflow. Positions are zero-based, meaning the first position is `0`.\r\n When omitted, the newly created phase is added as the last non-win phase.\r\n\r\n This function requires you to specify the ID of a workflow. To learn about retrieving\r\n IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]},{"name":"createWorkflow","fqn":"Workflows.createWorkflow","slug":"create-workflow","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["workflowInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfilled - ID of the newly created workflow."},"examples":[{"title":"Create a new workflow","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const createWorkflow = webMethod(Permissions.Anyone, () => {\n return workflows.createWorkflow(\n {\n \"name\": \"My Workflow\",\n \"description\":\"The best workflow!\"\n }\n );\n});\n\n// Returns a promise that resolves to:\n// \"3c9683ea-f6cc-470b-b0d1-2eb6b8cea912\""}],"actionParams":[{"name":"workflowInfo","slug":"workflow-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CreateWorkflowRequest","referenceFqn":"Workflows.CreateWorkflowRequest"},"description":"Workflow to create."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nCreates a new workflow.\r\n\r\n The `createWorkflow()` function returns a Promise that resolves to the created workflow\r\n ID.","sdkErrors":[]},{"name":"deleteCard","fqn":"Workflows.deleteCard","slug":"delete-card","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["cardId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the card has been deleted."},"examples":[{"title":"Delete a card","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const deleteCard = webMethod(Permissions.Anyone, (cardId) => {\n return workflows.deleteCard(cardId);\n});\n\n// Returns a promise that resolves to void."}],"actionParams":[{"name":"cardId","slug":"card-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the card to delete."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nDeletes a workflow card by ID.\r\n\r\n The `deleteCard()` function returns a Promise when the specified card\r\n has been deleted.\r\n\r\n This function requires you to specify the ID of a card. To learn about\r\n retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]},{"name":"deletePhase","fqn":"Workflows.deletePhase","slug":"delete-phase","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["phaseId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"Delete a phase","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const deletePhase = webMethod(Permissions.Anyone, (phaseId) => {\n return workflows.deletePhase(phaseId);\n});\n\n// Returns a promise that resolves to void."}],"actionParams":[{"name":"phaseId","slug":"phase-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the phase to delete."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nDeletes a workflow phase.\r\n\r\n The `deletePhase()` function returns a Promise when the specified phase\r\n has been deleted.\r\n\r\n This function requires you to specify the ID of a phase. To learn about\r\n retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]},{"name":"deleteWorkflow","fqn":"Workflows.deleteWorkflow","slug":"delete-workflow","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["workflowId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"Delete a workflow","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const deleteWorkflow = webMethod(Permissions.Anyone, (workflowId) => {\n return workflows.deleteWorkflow(workflowId);\n});\n\n// Returns a promise that resolves to void."}],"actionParams":[{"name":"workflowId","slug":"workflow-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the workflow to delete."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nDeletes a workflow.\r\n\r\n The `deleteWorkflow()` function returns a Promise when the specified workflow\r\n has been deleted.\r\n\r\n This function requires you to specify the ID of a workflow. To learn about retrieving\r\n IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]},{"name":"getCard","fqn":"Workflows.getCard","slug":"get-card","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["cardId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Card","referenceFqn":"Workflows.Card"},"description":"Fulfilled - Retrieved card."},"examples":[{"title":"Get a card","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const getCard = webMethod(Permissions.Anyone, (cardId) => {\n return workflows.getCard(cardId);\n});\n\n// Returns a promise that resolves to \n// {\n// \"name\": \"Card Name\",\n//\t \"id\": \"63c83c38-f504-4eb8-a48c-1d77c436a678\",\n// \"contactId\": \"95bc7a80-5500-4445-9c90-adc0ff1b25ac\",\n// \"phaseId\": \"15bc7a80-5500-4445-9c90-adc0ff1b25ac\",\n// \"createdDate\": \"2019-05-05T12:23:43Z\",\n// \"updatedDate\": \"2019-05-05T12:23:43Z\",\n// \"source\": \"Inbox\"\n// }"}],"actionParams":[{"name":"cardId","slug":"card-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the card to retrieve."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nRetrieves a workflow card by ID.\r\n\r\n The `getCard()` function returns a Promise that resolves to the card\r\n with the specified ID.\r\n\r\n This function requires you to specify the ID of a card. To learn about\r\n retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]},{"name":"getPhaseInfo","fqn":"Workflows.getPhaseInfo","slug":"get-phase-info","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["phaseId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Phase","referenceFqn":"Workflows.Phase"},"description":"Fulfilled - Retrieved phase."},"examples":[{"title":"Get a phase info","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const getPhaseInfo = webMethod(Permissions.Anyone, (phaseId) => {\n return workflows.getPhaseInfo(phaseId);\n});\n\n// Returns a promise that resolves to:\n// {\n// name: \"Phase Name\",\n// id: \"66f6443c-884f-4b12-beae-ab864fb489db\"\n// }"}],"actionParams":[{"name":"phaseId","slug":"phase-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the phase to retrieve."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nRetrieves a phase by ID.\r\n\r\n The `getPhaseInfo()` function returns a Promise that resolves to the phase\r\n with the specified ID.\r\n\r\n This function requires you to specify the ID of a phase. To learn about\r\n retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]},{"name":"getWorkflowInfo","fqn":"Workflows.getWorkflowInfo","slug":"get-workflow-info","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["workflowId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Workflow","referenceFqn":"Workflows.Workflow"},"description":"Fulfilled - Retrieved workflow."},"examples":[{"title":"Get a workflow","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const getWorkflowInfo = webMethod(Permissions.Anyone, (workflowId) => {\n return workflows.getWorkflowInfo(workflowId);\n});\n\n/* Returns a promise that resolves to:\n *\n * {\n * \"name\": \"My Workflow\",\n * \"id\": \"27cb0001-a464-4e1b-91c2-83d666577b75\",\n * \"createdDate\": \"2019-05-19T12:35:55.408Z\",\n * \"description\": \"Workflow description\"\n * }\n */"}],"actionParams":[{"name":"workflowId","slug":"workflow-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the workflow to retrieve."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nRetrieves a workflow by ID.\r\n\r\n The `getWorkflowInfo()` function returns a Promise that resolves to the workflow info\r\n with the specified ID.\r\n\r\n This function requires you to specify the ID of a workflow. To learn about retrieving\r\n IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]},{"name":"listCards","fqn":"Workflows.listCards","slug":"list-cards","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["workflowId","options"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CardList","referenceFqn":"Workflows.CardList"},"description":"Fulfilled - List of retrieved cards."},"examples":[{"title":"Get a list of cards","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const listCards = webMethod(Permissions.Anyone, (workflowId, phaseId) => {\n return workflows.listCards(\n workflowId,\n {\n \"phaseId\": phaseId, \n \"limit\": 2,\n \"skip\": 10,\n \"order\": {\n \"field\": \"name\",\n \"sort\": \"asc\"\n }\n });\n});\n\n/* Returns a promise that resolves to:\n * { \n * \"items\": [ \n * { \n * \"createdDate\": \"2019-05-21T12:21:10Z\",\n * \"updatedDate\": \"2019-05-21T12:21:10Z\",\n * \"name\": \"This is a card\",\n * \"id\": \"5ae263d5-0fdc-4378-9172-655d010cc6d1\",\n * \"contactId\": \"c4d0545b-f748-4e1f-93fb-6d8609fb2fb4\",\n * \"phaseId\": \"15bc7a80-5500-4445-9c90-adc0ff1b25ac\",\n * \"source\": \"Inbox\",\n * },\n * { \n * \"createdDate\": \"2019-05-21T12:21:10Z\",\n * \"updatedDate\": \"2019-05-21T12:21:10Z\",\n * \"name\": \"This is another card\",\n * \"id\": \"63d55ae2-9172-0fdc-4378-10cc6d1655d0\",\n * \"contactId\": \"c4d0545b-f748-4e1f-93fb-6d8609fb2fb4\",\n * \"phaseId\": \"25bc7a80-5500-4445-9c90-adc0ff1b25ac\",\n * \"source\": \"Wix Forms\",\n * }\n * ],\n * \"length\": 2,\n * \"totalCount\": 100,\n * \"pageSize\": 2,\n * \"totalPages\": 50,\n * \"currentPage\": 5\n * }\n */"}],"actionParams":[{"name":"workflowId","slug":"workflow-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the workflow to retrieve cards from."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListCardOptions","referenceFqn":"Workflows.ListCardOptions"},"description":"Options to use when retrieving the list of cards."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nRetrieves a list of a workflow's cards.\r\n\r\n The `listCards()` function returns a Promise that resolves to a list of the\r\n the specified workflow's cards.\r\n\r\n Use the `options` parameter to specify which cards to retrieve and in which\r\n order to retrieve them. Must use either `phaseId` or `fetchOnlyArchived`. \r\n Cards can be sorted based on their `\"id\"`, `\"name\"`,\r\n `\"phaseId\"`, `\"createdDate\"`, `\"updatedDate\"`, `\"source\"`, and `\"position\"`.\r\n If no `limit` parameter is passed, the first 50 cards are returned. Sort order\r\n defaults to by `\"phaseId\"` and then by `\"position\"` ascending.\r\n\r\n This function requires you to specify the ID of a workflow. To learn about\r\n retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]},{"name":"listPhasesInfo","fqn":"Workflows.listPhasesInfo","slug":"list-phases-info","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["workflowId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"PhaseList","referenceFqn":"Workflows.PhaseList"},"description":"Fulfilled - List of retrieved phases."},"examples":[{"title":"Get a list of phases info","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const listPhasesInfo = webMethod(Permissions.Anyone, (workflowId) => {\n return workflows.listPhasesInfo(\n workflowId,\n {\n \"limit\": 2,\n \"skip\": 10,\n \"order\": {\n \"field\": \"name\",\n \"sort\": \"asc\"\n }\n }\n );\n});\n\n/* Returns a promise that resolves to:\n * { \n * \"items\": [ \n * { \n * \"id\": \"b00831ee-cc5d-4447-81d7-2ca1828f07b2\",\n * \"name\": \"To-do\"\n * }, \n * { \n * \"id\": \"4c866e9d-4189-4570-8595-af43a1ea615e\",\n * \"name\": \"In Progress\"\n * }\n * ],\n * \"length\": 2,\n * \"totalCount\": 100,\n * \"pageSize\": 2,\n * \"totalPages\": 50,\n * \"currentPage\": 5\n * }\n */"}],"actionParams":[{"name":"workflowId","slug":"workflow-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the workflow to retrieve phases from."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListOptions","referenceFqn":"Workflows.ListOptions"},"description":"Options to use when retrieving the list of phases."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nRetrieves a list of a workflow's phases.\r\n\r\n The `listPhasesInfo()` function returns a Promise that resolves to a list containing\r\n information about the specified workflow's phases.\r\n\r\n Use the `options` parameter to specify which phases to retrieve and in which\r\n order to retrieve them. Phases can be sorted based on their `\"id\"`, `\"name\"`, and\r\n `\"position\"`. If no `limit` parameter is passed, the first 50 cards are returned.\r\n Sort order defaults to by `\"position\"` ascending.\r\n\r\n This function requires you to specify the ID of a workflow. To learn about\r\n retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]},{"name":"listWorkflowsInfo","fqn":"Workflows.listWorkflowsInfo","slug":"list-workflows-info","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"WorkflowList","referenceFqn":"Workflows.WorkflowList"},"description":"Fulfilled - List of retrieved workflows."},"examples":[{"title":"Get a list of workflows info","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const listWorkflowsInfo = webMethod(Permissions.Anyone, () => {\n return workflows.listWorkflowsInfo(\n {\n \"limit\": 2,\n \"skip\": 10,\n \"order\": {\n \"field\": \"name\",\n \"sort\": \"asc\"\n }\n }\n );\n});\n\n/* Returns a promise that resolves to:\n *\n * {\n * \"items\": [\n * {\n * \"id\": \"f01971ac-5514-43b0-bf6c-dde93345e4e3\",\n * \"name\": \"First Workflow\",\n * \"createdDate\": \"2019-03-25T12:19:28.952Z\",\n * \"description\": \"First workflow description.\",\n * },\n * {\n * \"id\": \"d5a7848d-121b-4ee3-ab53-9ec6f4acaecc\",\n * \"name\": \"Second Workflow\",\n * \"createdDate\": \"2019-05-05T09:49:16.580Z\",\n * \"description\": \"Second workflow description.\",\n * }\n * ],\n * \"length\": 2,\n * \"totalCount\": 100,\n * \"pageSize\": 2,\n * \"totalPages\": 50,\n * \"currentPage\": 5\n * }\n */"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListOptions","referenceFqn":"Workflows.ListOptions"},"description":"Options to use when getting the list of workflows."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nRetrieves a list of the site's workflows info.\r\n\r\n The `listWorkflowsInfo()` function returns a Promise that resolves to a list containing\r\n information about the site's workflows.\r\n\r\n Use the `options` parameter to specify which workflows to retrieve and in which\r\n order to retrieve them. Workflows can be sorted based on their `\"name\"`.\r\n If no `limit` parameter is passed, the first 100 workflows are returned. Sort order\r\n defaults to by `\"name\"` ascending.","sdkErrors":[]},{"name":"moveCard","fqn":"Workflows.moveCard","slug":"move-card","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["cardId","options"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the card has moved."},"examples":[{"title":"Move a card","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const moveCard = webMethod(Permissions.Anyone, async (cardId, options) => {\n return await workflows.moveCard(\n cardId,\n {\n \"newPosition\": 0\n }\n );\n});\n\n// Returns a promise that resolves to void."}],"actionParams":[{"name":"cardId","slug":"card-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the card to move."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MoveCardOptions","referenceFqn":"Workflows.MoveCardOptions"},"description":"Information about where to move the card."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nMoves a card to a new position within a workflow.\r\n\r\n The `moveCard()` function returns a Promise when the specified card\r\n has been moved to the new position.\r\n\r\n Use the `options` parameter to specify the phase\r\n and position within that phase to move the card to. Positions are zero-based,\r\n meaning the first position is `0`.\r\n\r\n This function requires you to specify the ID of a card. To learn about\r\n retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]},{"name":"movePhase","fqn":"Workflows.movePhase","slug":"move-phase","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["phaseId","options"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the phase has moved."},"examples":[{"title":"Move a phase","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const movePhase = webMethod(Permissions.Anyone, async (phaseId, workflowId) => {\n return await workflows.movePhase(\n phaseId,\n {\n \"workflowId\": workflowId,\n \"newPosition\": 0\n }\n );\n});\n\n// Returns a promise that resolves to void."}],"actionParams":[{"name":"phaseId","slug":"phase-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the phase to move."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MovePhaseOptions","referenceFqn":"Workflows.MovePhaseOptions"},"description":"Information about where to move the phase."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nMoves a phase to a new position with a workflow.\r\n\r\n The `movePhase()` function returns a Promise when the specified phase\r\n has been moved to the new position.\r\n\r\n Use the `options` parameter to specify the new phase\r\n position within the workflow. Any non-win phase can be moved to any non-win position. The win phase cannot\r\n be moved. Positions are zero-based, meaning the first position is `0`.\r\n\r\n This function requires you to specify the ID of a phase. To learn about\r\n retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]},{"name":"restoreCard","fqn":"Workflows.restoreCard","slug":"restore-card","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["cardId","options"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the card has been restored."},"examples":[{"title":"Restore a card","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const restoreCard = webMethod(Permissions.Anyone, async (cardId, phaseId) => {\n return await workflows.restoreCard(\n cardId,\n {\n \"newPhaseId\": phaseId,\n \"newPosition\": 0\n }\n );\n});\n\n// Returns a promise that resolves to void."}],"actionParams":[{"name":"cardId","slug":"card-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the card to restore."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MoveCardOptions","referenceFqn":"Workflows.MoveCardOptions"},"description":"Information about where to restore the card to."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nRestores an archived workflow card.\r\n\r\n The `restoreCard()` function returns a Promise that resolves when the\r\n archived card has been restored.\r\n\r\n This function requires you to specify the ID of a card. To learn about\r\n retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).\r\n\r\n> **Note:**\r\n> Each workflow is limited to 5,000 cards.\r\n> If this limit is reached, `createCard()` throws an error.\r\n> [Archive cards](#archivecard) when they're no longer needed\r\n> to reduce card count and avoid hitting the limit.","sdkErrors":[]},{"name":"updateCardFields","fqn":"Workflows.updateCardFields","slug":"update-card-fields","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["cardId","cardInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the card has been updated."},"examples":[{"title":"Update a card","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const updateCardFields = webMethod(Permissions.Anyone, (cardId, cardInfo) => {\n return workflows.updateCardFields(\n cardId, \n {\n \"name\": \"New Name\",\n \"contactId\": \"faad351b-fe07-4541-9157-358eba98b635\"\n }\n );\n});\n\n// Returns a promise that resolves to void"}],"actionParams":[{"name":"cardId","slug":"card-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the card to update."},{"name":"cardInfo","slug":"card-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateCardRequest","referenceFqn":"Workflows.UpdateCardRequest"},"description":"Card information to update."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nUpdates an existing workflow card.\r\n\r\n The `updateCardFields()` function returns a Promise that resolves when the\r\n card has been updated with the specified values.\r\n\r\n `contactId` is not a required field, but if the parameter is not passed, the field will default to empty and the card will not be associated with any contact.\r\n\r\n This function requires you to specify the ID of a card. To learn about\r\n retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]},{"name":"updatePhaseFields","fqn":"Workflows.updatePhaseFields","slug":"update-phase-fields","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["phaseId","phaseInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the phase has been updated."},"examples":[{"title":"Update a phase","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\nexport const updatePhaseFields = webMethod(Permissions.Anyone, (phaseId, phaseInfo) => {\n return workflows.updatePhaseFields(\n phaseId,\n {\n \"name\": \"New Name\"\n }\n );\n});\n\n// Returns a promise that resolves to void."}],"actionParams":[{"name":"phaseId","slug":"phase-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the phase to update."},{"name":"phaseInfo","slug":"phase-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdatePhaseRequest","referenceFqn":"Workflows.UpdatePhaseRequest"},"description":"Phase information to update."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nUpdates an existing workflow phase.\r\n\r\n The `updatePhaseFields()` function returns a Promise that resolves when the\r\n phase has been updated with the specified values.\r\n\r\n Only the properties passed in the `Phase` object will be\r\n updated. All other properties will remain the same.\r\n\r\n This function requires you to specify the ID of a phase. To learn about\r\n retrieving IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]},{"name":"updateWorkflowFields","fqn":"Workflows.updateWorkflowFields","slug":"update-workflow-fields","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["workflowId","workflowInfo"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the workflow has been updated."},"examples":[{"title":"Update a workflow","content":"import { Permissions, webMethod } from 'wix-web-module';\nimport { workflows } from 'wix-crm-backend';\n\n/* Sample workflowId value: \"c6dea502-1dd0-405f-906f-dcb9776e37e8\"\n *\n * Sample workflowInfo value:\n * {\n * \"name\": \"New name\"\n * }\n */\n\nexport const myUpdateWorkflowFunction = webMethod(Permissions.Anyone, async (workflowId, workflowInfo) => {\n try {\n const updatedWorkflow = await workflows.updateWorkflowFields(workflowId, workflowInfo);\n\n console.log('Success! Updated workflow:', updatedWorkflow);\n return updatedWorkflow;\n } catch (error) {\n console.error(error);\n }\n});\n\n// Returns a promise that resolves to void."}],"actionParams":[{"name":"workflowId","slug":"workflow-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the workflow to update."},{"name":"workflowInfo","slug":"workflow-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateWorkflowRequest","referenceFqn":"Workflows.UpdateWorkflowRequest"},"description":"Workflow information to update."}],"description":"**Deprecated.**\r\nThis function is being discontinued in the upcoming months. We are working to provide alternatives, \r\nand we'll provide timely updates before implementing any changes. We understand that this \r\ntransition might present challenges, and we appreciate your patience and understanding.\r\n\r\nUpdates an existing workflow.\r\n\r\n The `updateWorkflowFields()` function returns a Promise that resolves when the\r\n workflow has been updated with the specified values.\r\n\r\n Only the properties passed in the `workflow` object will be\r\n updated. All other properties will remain the same.\r\n\r\n This function requires you to specify the ID of a workflow. To learn about retrieving\r\n IDs in the Workflow API, see [Retrieving IDs](#retrieving-ids).","sdkErrors":[]}],"webhooks":[],"articles":[{"content":"# Introduction\n> **Note:** The Workflows API will be discontinued in the upcoming months. If you're already using this module in \nyour code, it will continue to work. Our team is \nworking to provide alternatives, and we'll provide timely updates before \nimplementing any changes. We understand that this transition might present challenges, \nand we appreciate your patience and understanding.\n\nThe Workflows API is used to manage your site's\n[workflows](https://support.wix.com/en/article/about-workflows).\n\n A workflow consists of a number of phases, also known as steps. The final phase\n in the workflow, the phase that indicates the workflow has been completed,\n is know as the win phase. Each phase can contain cards that move between the phases,\n indicating the card's progression through the workflow.\n\n### Before you begin\n\nEach workflow is limited to 5,000 cards.\nTo avoid hitting this limit, [archive cards](wix-crm-backend/workflows/archive-card)\nwhen they're no longer needed.\n\n ### Retrieving IDs\n\n When working with the Workflows API, you will often need to specify the ID of a\n workflow, phase, or card.\n\n You can retrieve these IDs using the following functions:\n\n + [`listWorkflowsInfo()`](#listWorkflowsInfo)\n + [`listPhasesInfo()`](#listPhasesInfo)\n + [`listCards()`](#listCards)\n\n Sometimes, you need to use more than one of these functions to retrieve\n the ID you need. For example, if you are looking to retrieve a specific card's ID\n using the [`listCards()`](#listCards) function, you need to at least provide a\n workflow ID. So, you call [`listWorkflowsInfo()`](#listWorkflowsInfo) to retrieve\n the workflow ID and then pass that ID to [`listCards()`](#listCards) to get the\n card ID.\n\n Note that IDs for workflows, phases, and cards are also returned when they are\n created using the [`createWorkflow()`](#createWorkflow), [`createPhase()`](#createPhase),\n and [`createCard()`](#createCard) functions. You can store these returned IDs and\n use them later.\n\n To use the Workflows API, import `workflows` from the `wix-crm-backend` module:\n\n ```javascript\n import { workflows } from 'wix-crm-backend';\n ```","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]}],"builderTypes":[],"properties":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.0"},"resourceMetadata":{"lastModifiedBy":"","sourcePath":"","yamlPath":"","name":"wix-crm-backend","yamlTitle":"Wix Crm Backend 1 0 0","kind":"VELO"}}