{"id":"8452dcf8-907c-4240-b273-b5802d0db799","createdDate":"2024-07-04T14:13:15.486Z","updatedDate":"2024-07-04T14:13:15.486Z","resourceId":"874fc7dd-ac32-4d57-8b43-3166eff8f210","api":{"schema":{"object":{"displayName":"Contact Object","description":"","slug":"contact-object","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","legacyExamples":[{"title":"Contact","content":"{\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:22:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"picture\": {\n \"id\": \"\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\":[\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\":[\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\"\n }\n ]\n },\n \"addresses\": {\n \"items\":[\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\" : \"Wix\",\n \"jobTitle\" : \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\" : \"en-us\",\n \"labelKeys\": {\n \"items\":[\n \"contacts.contacted-me\",\n \"custom.my-label\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"emailSubscriptions.subscriptionStatus\": \"SUBSCRIBED\",\n \"emailSubscriptions.deliverabilityStatus\": \"ACTIVE\",\n \"emailSubscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 2323,\n \"ecom.totalSpentCurrency\": \"USD\",\n \"ecom.lastPurchaseDate\": \"2018-10-30T17:22:10.299Z\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/crm.git"},"methods":[{"summary":"List Contacts","description":"Retrieves a list of up to 1,000 contacts per request.","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.ListContacts","parameters":[{"name":"sort","in":"query","description":"[Sort order](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter).","required":false,"schema":{"description":"[Sort order](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter).","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Sorting","summary":"sort","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"paging","in":"query","description":"[Pagination](https://dev.wix.com/api/rest/getting-started/pagination), defaults to offset = 0 and limit = 50 (max limit 1,000).","required":false,"schema":{"description":"[Pagination](https://dev.wix.com/api/rest/getting-started/pagination), defaults to offset = 0 and limit = 50 (max limit 1,000).","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"fields","in":"query","description":"List of projected fields to return.\nIf both `fields` and `fieldsets` are sent in the request,\nthe union of both lists is returned.\n`id` and `revision` are always returned.\n\nSupported properties:\n`source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,\n`info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,\n`info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,\n`info.labelKeys`, `info.locations`, `info.extendedFields`","required":false,"schema":{"description":"List of projected fields to return.\nIf both `fields` and `fieldsets` are sent in the request,\nthe union of both lists is returned.\n`id` and `revision` are always returned.\n\nSupported properties:\n`source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,\n`info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,\n`info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,\n`info.labelKeys`, `info.locations`, `info.extendedFields`","maxLength":100,"maxItems":100,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"fieldsets","in":"query","description":"","required":false,"schema":{"description":"","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactFieldSet"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ListContactsResponse","description":"List of contacts."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_SORT_FIELD"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ILLEGAL_LIMIT"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Contacts","scopeId":"SCOPE.DC-CONTACTS.READ-CONTACTS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.ListContactsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.ListContactsResponse"},"legacyExamples":[{"name":"ListContacts","serviceName":"ContactsServiceV4","type":"METHOD","order":3,"content":{"title":"List Contacts with Projected Fields","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts?fields=source&fields=info.name&fields=info.emails' \\\n -H 'Authorization: '","response":"{\n \"contacts\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"e50c4534-d0a5-11ea-87d0-0242ac130003\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Any\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"e50c487c-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"MAIN\",\n \"email\": \"email211@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"e50c4958-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"MAIN\",\n \"email\": \"email123213@example.com\"\n }\n ]\n }\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}},{"name":"ListContacts","serviceName":"ContactsServiceV4","type":"METHOD","order":1,"content":{"title":"List Contacts with `FULL` Fieldset","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts?fieldsets=FULL' \\\n -H 'Authorization: '","response":"{\n \"contacts\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:22:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"picture\": {\n \"id\": \"WixMedia image ID\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\":[\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\"\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"contacts.contacted-me\",\n \"custom.my-label\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"emailSubscriptions.subscriptionStatus\": \"SUBSCRIBED\",\n \"emailSubscriptions.deliverabilityStatus\": \"ACTIVE\",\n \"emailSubscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 2323,\n \"ecom.totalSpentCurrency\": \"USD\",\n \"ecom.lastPurchaseDate\": \"2018-10-30T17:22:10.299Z\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n },\n {\n \"id\": \"e50c4534-d0a5-11ea-87d0-0242ac130003\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"createdDate\": \"2019-10-30T17:48:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:59:10.299Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:59:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email211@example.com\",\n \"phone\": \"097499991\"\n },\n \"picture\": {\n \"id\": \"WixMedia image ID\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/e50c4764-d0a5-11ea-87d0-0242ac130003/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"e50c487c-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"MAIN\",\n \"email\": \"email211@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"e50c4958-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"MAIN\",\n \"email\": \"email123213@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e50c4bc4-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097499991\",\n \"e164Phone\": \"+97297499991\",\n \"primary\": true\n },\n {\n \"id\": \"e50c4ca0-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443875571\",\n \"e164Phone\": \"+380443875571\"\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"e50c4d5e-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-OH\",\n \"city\": \"Athens\",\n \"postalCode\": \"45701\",\n \"addressLine\": \"19 E Cir Dr\"\n }\n },\n {\n \"id\": \"e50c4e26-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-OH\",\n \"city\": \"Athens\",\n \"postalCode\": \"45701\",\n \"streetAddress\": {\n \"number\": \"305\",\n \"name\": \"W Union St\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"QA engineer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"contacts.contacted-me\",\n \"custom.my-label\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Green\",\n \"custom.number\": 1984,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"subscriptions.subscriptionStatus\": \"NOT SET\",\n \"subscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 18,\n \"ecom.totalSpentCurrency\": \"EUR\",\n \"ecom.lastPurchaseDate\": \"2018-10-30T17:22:10.299Z\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\"\n ]\n }\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}},{"name":"ListContacts","serviceName":"ContactsServiceV4","type":"METHOD","order":4,"content":{"title":"List Contacts, Sorted","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts?fields=source&fields=info.name&fields=info.emails&sort.fieldName=info.name.first&sort.order=ASC' \\\n -H 'Authorization: '","response":"{\n \"contacts\": [\n {\n \"id\": \"e50c4534-d0a5-11ea-87d0-0242ac130003\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Any\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"e50c487c-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"MAIN\",\n \"email\": \"email211@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"e50c4958-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"MAIN\",\n \"email\": \"email123213@example.com\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n }\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}},{"name":"ListContacts","serviceName":"ContactsServiceV4","type":"METHOD","order":2,"content":{"title":"List Contacts, Paginated","description":"Lists contacts using the requested offset and limit.","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts?paging.limit=2&paging.offset=10' \\\n -H 'Authorization: '","response":"{\n \"contacts\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n }\n }\n },\n {\n \"id\": \"e50c4534-d0a5-11ea-87d0-0242ac130003\",\n \"revision\": 1,\n \"primaryInfo\": {\n \"email\": \"email211@example.com\",\n \"phone\": \"097499991\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Any\",\n \"last\": \"One\"\n },\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": 12,\n \"too_many_to_count\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"get","path":"/v4/contacts","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_SORT_FIELD"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ILLEGAL_LIMIT"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Contacts","scopeId":"SCOPE.DC-CONTACTS.READ-CONTACTS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.ListContactsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.ListContactsResponse"},"legacyExamples":[{"name":"ListContacts","serviceName":"ContactsServiceV4","type":"METHOD","order":3,"content":{"title":"List Contacts with Projected Fields","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts?fields=source&fields=info.name&fields=info.emails' \\\n -H 'Authorization: '","response":"{\n \"contacts\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"e50c4534-d0a5-11ea-87d0-0242ac130003\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Any\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"e50c487c-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"MAIN\",\n \"email\": \"email211@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"e50c4958-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"MAIN\",\n \"email\": \"email123213@example.com\"\n }\n ]\n }\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}},{"name":"ListContacts","serviceName":"ContactsServiceV4","type":"METHOD","order":1,"content":{"title":"List Contacts with `FULL` Fieldset","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts?fieldsets=FULL' \\\n -H 'Authorization: '","response":"{\n \"contacts\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:22:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"picture\": {\n \"id\": \"WixMedia image ID\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\":[\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\"\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"contacts.contacted-me\",\n \"custom.my-label\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"emailSubscriptions.subscriptionStatus\": \"SUBSCRIBED\",\n \"emailSubscriptions.deliverabilityStatus\": \"ACTIVE\",\n \"emailSubscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 2323,\n \"ecom.totalSpentCurrency\": \"USD\",\n \"ecom.lastPurchaseDate\": \"2018-10-30T17:22:10.299Z\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n },\n {\n \"id\": \"e50c4534-d0a5-11ea-87d0-0242ac130003\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"createdDate\": \"2019-10-30T17:48:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:59:10.299Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:59:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email211@example.com\",\n \"phone\": \"097499991\"\n },\n \"picture\": {\n \"id\": \"WixMedia image ID\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/e50c4764-d0a5-11ea-87d0-0242ac130003/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"e50c487c-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"MAIN\",\n \"email\": \"email211@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"e50c4958-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"MAIN\",\n \"email\": \"email123213@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e50c4bc4-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097499991\",\n \"e164Phone\": \"+97297499991\",\n \"primary\": true\n },\n {\n \"id\": \"e50c4ca0-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443875571\",\n \"e164Phone\": \"+380443875571\"\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"e50c4d5e-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-OH\",\n \"city\": \"Athens\",\n \"postalCode\": \"45701\",\n \"addressLine\": \"19 E Cir Dr\"\n }\n },\n {\n \"id\": \"e50c4e26-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-OH\",\n \"city\": \"Athens\",\n \"postalCode\": \"45701\",\n \"streetAddress\": {\n \"number\": \"305\",\n \"name\": \"W Union St\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"QA engineer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"contacts.contacted-me\",\n \"custom.my-label\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Green\",\n \"custom.number\": 1984,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"subscriptions.subscriptionStatus\": \"NOT SET\",\n \"subscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 18,\n \"ecom.totalSpentCurrency\": \"EUR\",\n \"ecom.lastPurchaseDate\": \"2018-10-30T17:22:10.299Z\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\"\n ]\n }\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}},{"name":"ListContacts","serviceName":"ContactsServiceV4","type":"METHOD","order":4,"content":{"title":"List Contacts, Sorted","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts?fields=source&fields=info.name&fields=info.emails&sort.fieldName=info.name.first&sort.order=ASC' \\\n -H 'Authorization: '","response":"{\n \"contacts\": [\n {\n \"id\": \"e50c4534-d0a5-11ea-87d0-0242ac130003\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Any\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"e50c487c-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"MAIN\",\n \"email\": \"email211@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"e50c4958-d0a5-11ea-87d0-0242ac130003\",\n \"tag\": \"MAIN\",\n \"email\": \"email123213@example.com\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n }\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}},{"name":"ListContacts","serviceName":"ContactsServiceV4","type":"METHOD","order":2,"content":{"title":"List Contacts, Paginated","description":"Lists contacts using the requested offset and limit.","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts?paging.limit=2&paging.offset=10' \\\n -H 'Authorization: '","response":"{\n \"contacts\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n }\n }\n },\n {\n \"id\": \"e50c4534-d0a5-11ea-87d0-0242ac130003\",\n \"revision\": 1,\n \"primaryInfo\": {\n \"email\": \"email211@example.com\",\n \"phone\": \"097499991\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Any\",\n \"last\": \"One\"\n },\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": 12,\n \"too_many_to_count\": true\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"List Contacts","slugifiedName":"list-contacts"}},{"summary":"Create Contact","description":"Creates a new contact.\n\nThe request body must include a name, a phone number, or an email address.\nIf all 3 of these parameters are missing,\nthe contact won't be created.\n\nBy default,\nif the creation request contains an email already in use by another contact,\nthe new contact won't be created.\nTo override this behavior, set `allowDuplicates` to `true`.","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.CreateContact","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.CreateContactResponse","description":"Contact."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateContactRequest","description":"Contact creation options.","properties":{"info":{"description":"Contact info.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactInfo","summary":"info","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allowDuplicates":{"description":"Controls whether the call will succeed\nif the new contact information contains an email or a phone number already used by another contact.\n\nIf set to `true`,\nthe call will succeed even if an email address or phone number is used by another contact.\nIf set to `false`,\nthe call will fail if the given email address is used by another contact or,\nif the email address is not given and the given phone number is used by another contact.\n\nDefault: `false`","title":"allowDuplicates","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["info"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Contact Created","description":"Triggered when a contact is created.","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_created","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_CONTACT_EXISTS","errorSchemaName":"com.wixpress.contacts.core.api.v4.DuplicateContactExists"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INSUFFICIENT_CONTACT_DATA"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"CONTACT_ID_ALREADY_EXISTS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_HAVE_MULTIPLE_PRIMARY_INFO"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_EXTENDED_FIELD_VALUE"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.CreateContactRequest","responseMessage":"com.wixpress.contacts.core.api.v4.CreateContactResponse"},"legacyExamples":[{"name":"CreateContact","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Create Contact","description":"Creates a contact with basic info,","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\"\n },\n {\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\"\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"custom.label-a\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n }'","response":"{\n \"contact\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"WIX_APP\",\n \"appId\": \"9da8bff7-68c9-49d4-8cfd-ba534fd34d68\"\n },\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:22:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"picture\": {\n \"id\": \"WixMedia image ID\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\",\n \"primary\": false\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"custom.label-a\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"emailSubscriptions.effectiveEmail\": \"email@example.com\",\n \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n \"contacts.displayByFirstName\": \"Some One\",\n \"contacts.displayByLastName\": \"One Some\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v4/contacts","rpcOnly":false,"triggeredEvents":[{"title":"Contact Created","description":"Triggered when a contact is created.","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_created","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_CONTACT_EXISTS","errorSchemaName":"com.wixpress.contacts.core.api.v4.DuplicateContactExists"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INSUFFICIENT_CONTACT_DATA"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"CONTACT_ID_ALREADY_EXISTS"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_HAVE_MULTIPLE_PRIMARY_INFO"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_EXTENDED_FIELD_VALUE"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.CreateContactRequest","responseMessage":"com.wixpress.contacts.core.api.v4.CreateContactResponse"},"legacyExamples":[{"name":"CreateContact","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Create Contact","description":"Creates a contact with basic info,","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\"\n },\n {\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\"\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"custom.label-a\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n }'","response":"{\n \"contact\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"WIX_APP\",\n \"appId\": \"9da8bff7-68c9-49d4-8cfd-ba534fd34d68\"\n },\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:22:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"picture\": {\n \"id\": \"WixMedia image ID\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\",\n \"primary\": false\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"custom.label-a\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"emailSubscriptions.effectiveEmail\": \"email@example.com\",\n \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n \"contacts.displayByFirstName\": \"Some One\",\n \"contacts.displayByLastName\": \"One Some\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Create Contact","slugifiedName":"create-contact"}},{"summary":"Delete Contact","description":"Deletes a contact.\n\nDeleting a contact permanently removes them from the Contact List.\n\nIf a contact is also a site member or site contributor, or has a valid billing subscriptions,\nthe contact cannot be deleted.\nThe related site member or site contributor must first be deleted and any valid billing subscriptions must be canceled,\nbefore the contact can also be deleted.\n\nMembers are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.DeleteContact","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"contactId","description":"ID of the contact to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.DeleteContactResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Contact Deleted","description":"Triggered when a contact is deleted.\n\nIf a contact is deleted as part of a merge,\nthe `originatedFrom` property is sent as `merge`.\nOtherwise, `originatedFrom` is omitted.","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_deleted","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_DELETE_MEMBER"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_DELETE_CONTACT_WITH_BILLING_SUBSCRIPTION"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_DELETE_MEMBER_OWNER_OR_CONTRIBUTOR"},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"FAILED_DELETE_CONTACT_AFTER_MEMBER_DELETION"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY","MEMBERS.MEMBER_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.DeleteContactRequest","responseMessage":"com.wixpress.contacts.core.api.v4.DeleteContactResponse"},"legacyExamples":[{"name":"DeleteContact","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Delete Contact","request":"curl -X DELETE \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"delete","path":"/v4/contacts/{contactId}","rpcOnly":false,"triggeredEvents":[{"title":"Contact Deleted","description":"Triggered when a contact is deleted.\n\nIf a contact is deleted as part of a merge,\nthe `originatedFrom` property is sent as `merge`.\nOtherwise, `originatedFrom` is omitted.","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_deleted","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_DELETE_MEMBER"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_DELETE_CONTACT_WITH_BILLING_SUBSCRIPTION"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"CANNOT_DELETE_MEMBER_OWNER_OR_CONTRIBUTOR"},{"httpCode":500,"statusCode":"INTERNAL","applicationCode":"FAILED_DELETE_CONTACT_AFTER_MEMBER_DELETION"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY","MEMBERS.MEMBER_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.DeleteContactRequest","responseMessage":"com.wixpress.contacts.core.api.v4.DeleteContactResponse"},"legacyExamples":[{"name":"DeleteContact","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Delete Contact","request":"curl -X DELETE \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Delete Contact","slugifiedName":"delete-contact"}},{"summary":"Update Contact","description":"Updates a contact.\n\nEach time the contact is updated,\n`revision` increments by 1.\nThe existing `revision` must be included when updating the contact.\nThis ensures you're working with the latest contact information,\nand it prevents unintended overwrites.\n\nMembers are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.UpdateContact","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"contactId","description":"ID of the contact to update.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.UpdateContactResponse","description":"Updated contact."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateContactRequest","description":"","properties":{"revision":{"description":"Revision number.\nWhen updating, include the existing `revision`\nto prevent conflicting updates.","title":"revision","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allowDuplicates":{"description":"Controls whether the call will succeed\nif the new contact information contains an email or a phone number already used by another contact.\n\nIf set to `true`,\nthe call will succeed even if an email address or phone number is used by another contact.\nIf set to `false`,\nthe call will fail if the given email address is used by another contact or,\nif the email address is not given and the given phone number is used by another contact.\n\nDefault: `false`","title":"allowDuplicates","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"info":{"description":"Contact info.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactInfo","summary":"info","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["contactId","revision","info"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Contact Updated","description":"","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_updated","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_CONTACT_EXISTS","errorSchemaName":"com.wixpress.contacts.core.api.v4.DuplicateContactExists"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"CONTACT_ALREADY_CHANGED"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INSUFFICIENT_CONTACT_DATA"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CONTACT_NOT_FOUND"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INSUFFICIENT_UPDATE_CONTACT_DATA"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_HAVE_MULTIPLE_PRIMARY_INFO"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_EXTENDED_FIELD_VALUE"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY","CONTACTS.MODIFY_MEMBERSHIP_STATUS","CONTACTS.MODIFY_MEMBER_PRIMARY_EMAIL_PERMISSION"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.UpdateContactRequest","responseMessage":"com.wixpress.contacts.core.api.v4.UpdateContactResponse"},"legacyExamples":[{"name":"UpdateContact","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Update Contact","description":"Updates only the given fields (`company` and `addresses`).","request":"curl -X PATCH \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"info\": {\n \"name\": {\n \"first\": \"Ignored\",\n \"last\": \"Changed\"\n },\n \"company\" : \"Wix\",\n },\n \"revision\": 5,\n \"allowDuplicates\": false\n }'","response":"{\n \"contact\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 6,\n \"source\": {\n \"sourceType\": \"WIX_APP\",\n \"appId\": \"9da8bff7-68c9-49d4-8cfd-ba534fd34d68\"\n },\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2020-10-02T08:43:25.765Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:22:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"picture\": {\n \"id\": \"WixMedia image ID\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"Changed\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\",\n \"primary\": false\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"custom.label-a\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"emailSubscriptions.effectiveEmail\": \"email@example.com\",\n \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n \"contacts.displayByFirstName\": \"Some One\",\n \"contacts.displayByLastName\": \"One Some\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"patch","path":"/v4/contacts/{contactId}","rpcOnly":false,"triggeredEvents":[{"title":"Contact Updated","description":"","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_updated","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"DUPLICATE_CONTACT_EXISTS","errorSchemaName":"com.wixpress.contacts.core.api.v4.DuplicateContactExists"},{"httpCode":409,"statusCode":"ALREADY_EXISTS","applicationCode":"CONTACT_ALREADY_CHANGED"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INSUFFICIENT_CONTACT_DATA"},{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CONTACT_NOT_FOUND"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INSUFFICIENT_UPDATE_CONTACT_DATA"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CANNOT_HAVE_MULTIPLE_PRIMARY_INFO"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_EXTENDED_FIELD_VALUE"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY","CONTACTS.MODIFY_MEMBERSHIP_STATUS","CONTACTS.MODIFY_MEMBER_PRIMARY_EMAIL_PERMISSION"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.UpdateContactRequest","responseMessage":"com.wixpress.contacts.core.api.v4.UpdateContactResponse"},"legacyExamples":[{"name":"UpdateContact","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Update Contact","description":"Updates only the given fields (`company` and `addresses`).","request":"curl -X PATCH \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"info\": {\n \"name\": {\n \"first\": \"Ignored\",\n \"last\": \"Changed\"\n },\n \"company\" : \"Wix\",\n },\n \"revision\": 5,\n \"allowDuplicates\": false\n }'","response":"{\n \"contact\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 6,\n \"source\": {\n \"sourceType\": \"WIX_APP\",\n \"appId\": \"9da8bff7-68c9-49d4-8cfd-ba534fd34d68\"\n },\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2020-10-02T08:43:25.765Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:22:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"picture\": {\n \"id\": \"WixMedia image ID\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"Changed\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\",\n \"primary\": false\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"custom.label-a\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"emailSubscriptions.effectiveEmail\": \"email@example.com\",\n \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n \"contacts.displayByFirstName\": \"Some One\",\n \"contacts.displayByLastName\": \"One Some\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Update Contact","slugifiedName":"update-contact"}},{"summary":"Merge Contacts","description":"Merges source contacts into a target contact.\n\nMerging contacts has these effects on the target contact:\n\n- No target contact data is overwritten or deleted.\n- Arrays (emails, phones, addresses, and labels) are merged from the source contacts.\n- If merging more than one source contact, the 1st source is given precedence, then the 2nd, and so on.\n\n

\n\n__Important:__\nMerges cannot be undone.\nUse [Preview Merge Contacts](#preview-merge-contacts)\nto test before merging.\n\n

\n\nSource contacts are deleted when merging.\nHowever, if a source contact is a site member or contributor,\nthe merge fails because site contributors and members can't be deleted.\nSite members and contributors can be target contacts only.\n\nAfter merging,\nif you call [Get Contact](#get-contact) with a deleted source contact ID,\nthe target contact ID is returned.\nThis is supported when calling Get Contact only.\nDeleted source contact IDs are not supported on any other endpoint.\n\nMerging contacts triggers these webhooks:\n\n- [Contact Merged](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-merged-webhook) is triggered.\n- [Contact Updated](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-updated-webhook) is triggered for the target contact. `originatedFrom` is set to `merge`.\n- [Contact Deleted](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-deleted-webhook) is triggered for each source contact. `originatedFrom` is set to `merge`.","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.MergeContacts","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"targetContactId","description":"Target contact ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.MergeContactsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"MergeContactsRequest","description":"","properties":{"targetContactRevision":{"description":"Target contact revision number, which increments by 1 each time the contact is updated.\nTo prevent conflicting changes,\nthe target contact's current revision must be passed.","title":"targetContactRevision","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sourceContactIds":{"description":"IDs of up to 5 contacts to merge into the target contact.\nIf merging more than one source contact,\nthe first source is given precedence, then the second, and so on.","minItems":1,"maxItems":5,"title":"sourceContactIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["targetContactId","targetContactRevision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Contact Merged","description":"Triggered when one or more source contacts are merged into a target contact.\n\nMerging contacts triggers these webhooks:\n\n- [Contact Merged](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-merged-webhook) is triggered.\n- [Contact Updated](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-updated-webhook) is triggered for the target contact. `originatedFrom` is set to `merge`.\n- [Contact Deleted](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-deleted-webhook) is triggered for each source contact. `originatedFrom` is set to `merge`.\n\nIf your app handles the originating merge event,\nit can ignore update and delete events where `originatedFrom` is set to `merge`.\nWhen Contact Updated and Contact Deleted are not triggered from a merge,\n`originatedFrom` is omitted from their payloads.","permissions":["CONTACTS.VIEW"],"payload":{"schemaName":"com.wixpress.contacts.core.api.v4.events.ContactMerged"},"exposure":"PUBLIC","maturity":"GA","slug":"merged","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_merged","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CONTACT_NOT_FOUND"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"FAILED_PRECONDITION"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ILLEGAL_MERGE"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MERGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.MergeContactsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.MergeContactsResponse"},"legacyExamples":[{"name":"MergeContacts","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Merge Contacts","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47/merge' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n targetContactRevision: 2,\n sourceContactIds: [\"f274f4a0-664a-457a-a83a-d46ea5fb9f54\"]\n }'","response":"{\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 2,\n \"primaryInfo\": {\n \"email\": \"target@example.com\",\n \"phone\": \"097495550\"\n },\n \"info\": {\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"target@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"c7f05j8c-af92-4237-833f-43aaaa2b4968\",\n \"tag\": \"MAIN\",\n \"email\": \"source@example.com\",\n \"primary\": false\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"as465d4c-dht4-4eff-ftr4-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"78457445\",\n \"e164Phone\": \"+972978457445\",\n \"primary\": false\n }\n ]\n },\n \"jobTitle\" : \"Developer\",\n \"company\" : \"Wix\",\n \"labelKeys\": {\n \"items\": [\n \"contacts.contacted-me\",\n \"custom.my-label\",\n \"custom.my-other-label\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.food\": \"Pizza\"\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v4/contacts/{targetContactId}/merge","rpcOnly":false,"triggeredEvents":[{"title":"Contact Merged","description":"Triggered when one or more source contacts are merged into a target contact.\n\nMerging contacts triggers these webhooks:\n\n- [Contact Merged](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-merged-webhook) is triggered.\n- [Contact Updated](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-updated-webhook) is triggered for the target contact. `originatedFrom` is set to `merge`.\n- [Contact Deleted](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-deleted-webhook) is triggered for each source contact. `originatedFrom` is set to `merge`.\n\nIf your app handles the originating merge event,\nit can ignore update and delete events where `originatedFrom` is set to `merge`.\nWhen Contact Updated and Contact Deleted are not triggered from a merge,\n`originatedFrom` is omitted from their payloads.","permissions":["CONTACTS.VIEW"],"payload":{"schemaName":"com.wixpress.contacts.core.api.v4.events.ContactMerged"},"exposure":"PUBLIC","maturity":"GA","slug":"merged","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_merged","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CONTACT_NOT_FOUND"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"FAILED_PRECONDITION"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ILLEGAL_MERGE"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MERGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.MergeContactsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.MergeContactsResponse"},"legacyExamples":[{"name":"MergeContacts","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Merge Contacts","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47/merge' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n targetContactRevision: 2,\n sourceContactIds: [\"f274f4a0-664a-457a-a83a-d46ea5fb9f54\"]\n }'","response":"{\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 2,\n \"primaryInfo\": {\n \"email\": \"target@example.com\",\n \"phone\": \"097495550\"\n },\n \"info\": {\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"target@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"c7f05j8c-af92-4237-833f-43aaaa2b4968\",\n \"tag\": \"MAIN\",\n \"email\": \"source@example.com\",\n \"primary\": false\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"as465d4c-dht4-4eff-ftr4-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"78457445\",\n \"e164Phone\": \"+972978457445\",\n \"primary\": false\n }\n ]\n },\n \"jobTitle\" : \"Developer\",\n \"company\" : \"Wix\",\n \"labelKeys\": {\n \"items\": [\n \"contacts.contacted-me\",\n \"custom.my-label\",\n \"custom.my-other-label\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.food\": \"Pizza\"\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Merge Contacts","slugifiedName":"merge-contacts"}},{"summary":"Preview Merge Contacts","description":"Previews merging source contacts into a target contact.\n\nThis endpoint performs a dry run without deleting or updating any contacts.\nA preview of the updated target contact is returned,\nbut no data is changed in the Contact List.\n\nTo perform the actual merge, use [Merge Contacts](#merge-contacts).\n\nMembers are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.PreviewMergeContacts","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"targetContactId","description":"Target contact ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.PreviewMergeContactsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"PreviewMergeContactsRequest","description":"","properties":{"sourceContactIds":{"description":"IDs of up to 5 contacts to merge into the target contact.\nIf merging more than one source contact,\nthe first source is given precedence, then the second, and so on.","minItems":1,"maxItems":5,"title":"sourceContactIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["targetContactId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CONTACT_NOT_FOUND"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"FAILED_PRECONDITION"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ILLEGAL_MERGE"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MERGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.PreviewMergeContactsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.PreviewMergeContactsResponse"},"legacyExamples":[{"name":"PreviewMergeContacts","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Merge Contacts Preview","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47/preview-merge' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n sourceContactIds: [\"f274f4a0-664a-457a-a83a-d46ea5fb9f54\"]\n }'","response":"{\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 2,\n \"primaryInfo\": {\n \"email\": \"target@example.com\",\n \"phone\": \"097495550\"\n },\n \"info\": {\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"target@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"c7f05j8c-af92-4237-833f-43aaaa2b4968\",\n \"tag\": \"MAIN\",\n \"email\": \"source@example.com\",\n \"primary\": false\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"as465d4c-dht4-4eff-ftr4-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"78457445\",\n \"e164Phone\": \"+972978457445\",\n \"primary\": false\n }\n ]\n },\n \"jobTitle\" : \"Developer\",\n \"company\" : \"Wix\",\n \"labelKeys\": {\n \"items\": [\n \"contacts.contacted-me\",\n \"custom.my-label\",\n \"custom.my-other-label\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.food\": \"Pizza\"\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v4/contacts/{targetContactId}/preview-merge","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CONTACT_NOT_FOUND"},{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"FAILED_PRECONDITION"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ILLEGAL_MERGE"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MERGE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.PreviewMergeContactsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.PreviewMergeContactsResponse"},"legacyExamples":[{"name":"PreviewMergeContacts","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Merge Contacts Preview","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47/preview-merge' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n sourceContactIds: [\"f274f4a0-664a-457a-a83a-d46ea5fb9f54\"]\n }'","response":"{\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 2,\n \"primaryInfo\": {\n \"email\": \"target@example.com\",\n \"phone\": \"097495550\"\n },\n \"info\": {\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"target@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"c7f05j8c-af92-4237-833f-43aaaa2b4968\",\n \"tag\": \"MAIN\",\n \"email\": \"source@example.com\",\n \"primary\": false\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"as465d4c-dht4-4eff-ftr4-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"78457445\",\n \"e164Phone\": \"+972978457445\",\n \"primary\": false\n }\n ]\n },\n \"jobTitle\" : \"Developer\",\n \"company\" : \"Wix\",\n \"labelKeys\": {\n \"items\": [\n \"contacts.contacted-me\",\n \"custom.my-label\",\n \"custom.my-other-label\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.food\": \"Pizza\"\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Preview Merge Contacts","slugifiedName":"preview-merge-contacts"}},{"summary":"Label Contact","description":"Adds labels to a contact.\n\n- **To create new labels:** Use [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label).\n- **To find labels:** Use [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label), [Get Label](https://dev.wix.com/api/rest/contacts/labels/get-label), or [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels).\n\nMembers are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.LabelContact","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"contactId","description":"ID of the contact to add labels to.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.LabelContactResponse","description":"Updated contact."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"LabelContactRequest","description":"","properties":{"labelKeys":{"description":"List of label keys to add to the contact.\n\nLabel keys must exist to be added to the contact.\nContact labels can be created or retrieved with\n[Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)\nor\n[List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels).","minItems":1,"maxItems":100,"title":"labelKeys","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["contactId","labelKeys"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Contact Updated","description":"","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_updated","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CONTACT_NOT_FOUND"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.LabelContactRequest","responseMessage":"com.wixpress.contacts.core.api.v4.LabelContactResponse"},"legacyExamples":[{"name":"LabelContact","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Add Labels to Contact","description":"Labels a contact with the requested label keys","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47/labels' \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"labelKeys\": [\"custom.label-a\", \"custom.label-b\"]\n }'","response":"{\n \"contact\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:22:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"picture\": {\n \"id\": \"WixMedia image ID\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\"\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"contacts.contacted-me\",\n \"custom.label-a\",\n \"custom.label-b\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"emailSubscriptions.subscriptionStatus\": \"SUBSCRIBED\",\n \"emailSubscriptions.deliverabilityStatus\": \"ACTIVE\",\n \"emailSubscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 2323,\n \"ecom.totalSpentCurrency\": \"USD\",\n \"ecom.lastPurchaseDate\": \"2018-10-30T17:22:10.299Z\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v4/contacts/{contactId}/labels","rpcOnly":false,"triggeredEvents":[{"title":"Contact Updated","description":"","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_updated","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CONTACT_NOT_FOUND"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.LabelContactRequest","responseMessage":"com.wixpress.contacts.core.api.v4.LabelContactResponse"},"legacyExamples":[{"name":"LabelContact","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Add Labels to Contact","description":"Labels a contact with the requested label keys","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47/labels' \\\n -H 'Authorization: '\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"labelKeys\": [\"custom.label-a\", \"custom.label-b\"]\n }'","response":"{\n \"contact\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:22:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"picture\": {\n \"id\": \"WixMedia image ID\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\"\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"contacts.contacted-me\",\n \"custom.label-a\",\n \"custom.label-b\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"emailSubscriptions.subscriptionStatus\": \"SUBSCRIBED\",\n \"emailSubscriptions.deliverabilityStatus\": \"ACTIVE\",\n \"emailSubscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 2323,\n \"ecom.totalSpentCurrency\": \"USD\",\n \"ecom.lastPurchaseDate\": \"2018-10-30T17:22:10.299Z\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Label Contact","slugifiedName":"label-contact"}},{"summary":"Unlabel Contact","description":"Removes labels from a contact.\n\nIf a label is no longer needed\nand you want to remove it from all contacts,\nyou can delete it with\n[Delete Label](https://dev.wix.com/api/rest/contacts/labels/delete-label)\n(in the Labels API).\n\nMembers are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.UnlabelContact","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"contactId","description":"ID of the contact to remove labels from.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"labelKeys","in":"query","description":"List of label keys to remove from the contact.","required":true,"schema":{"description":"List of label keys to remove from the contact.","minItems":1,"maxItems":100,"title":"labelKeys","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.UnlabelContactResponse","description":"Updated contact."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Contact Updated","description":"","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_updated","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CONTACT_NOT_FOUND"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.UnlabelContactRequest","responseMessage":"com.wixpress.contacts.core.api.v4.UnlabelContactResponse"},"legacyExamples":[{"name":"UnlabelContact","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Remove Label from Contact","request":"curl -X DELETE \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47/labels' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"labelKeys\": [\"custom.label-a\", \"custom.label-b\"]\n }'","response":"{\n \"contact\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:22:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"picture\": {\n \"id\": \"WixMedia image ID\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\"\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"contacts.contacted-me\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"emailSubscriptions.subscriptionStatus\": \"SUBSCRIBED\",\n \"emailSubscriptions.deliverabilityStatus\": \"ACTIVE\",\n \"emailSubscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 2323,\n \"ecom.totalSpentCurrency\": \"USD\",\n \"ecom.lastPurchaseDate\": \"2018-10-30T17:22:10.299Z\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"delete","path":"/v4/contacts/{contactId}/labels","rpcOnly":false,"triggeredEvents":[{"title":"Contact Updated","description":"","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_updated","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CONTACT_NOT_FOUND"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.UnlabelContactRequest","responseMessage":"com.wixpress.contacts.core.api.v4.UnlabelContactResponse"},"legacyExamples":[{"name":"UnlabelContact","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Remove Label from Contact","request":"curl -X DELETE \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47/labels' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"labelKeys\": [\"custom.label-a\", \"custom.label-b\"]\n }'","response":"{\n \"contact\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:22:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"picture\": {\n \"id\": \"WixMedia image ID\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\"\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"contacts.contacted-me\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"emailSubscriptions.subscriptionStatus\": \"SUBSCRIBED\",\n \"emailSubscriptions.deliverabilityStatus\": \"ACTIVE\",\n \"emailSubscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 2323,\n \"ecom.totalSpentCurrency\": \"USD\",\n \"ecom.lastPurchaseDate\": \"2018-10-30T17:22:10.299Z\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Unlabel Contact","slugifiedName":"unlabel-contact"}},{"summary":"Query Contacts","description":"Retrieves a list of contacts, given the provided [paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging), [filtering, and sorting](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/sort-filter-and-search).\n\nUp to 1,000 contacts can be returned per request.\nQuery Contacts runs with these defaults, which you can override:\n\n- `createdDate` is sorted in `ASC` order\n- `paging.limit` is `50`\n- `paging.offset` is `0`\n\n\nFor field support for filters and sorting, see\n[Contacts: Supported Filters and Sorting](https://dev.wix.com/api/rest/contacts/contacts-supported-filters-sorting-and-search).\n\nTo learn about working with _Query_ endpoints, see\n[API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),\n[Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging),\nand [Field Projection](https://dev.wix.com/docs/rest/articles/getting-started/field-projection).","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.QueryContacts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.QueryContactsResponse","description":"List of contacts."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryContactsRequest","description":"","properties":{"search":{"description":"Plain text search for an exact match.\n\nSupported properties:\n`info.name.first`, `info.name.last`, `info.emails.email`, `info.phones.phone`\n\nMax: 100 characters","maxLength":100,"title":"search","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"query":{"description":"Query options.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.query.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_SORT_FIELD"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ILLEGAL_LIMIT"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MALFORMED_FILTER"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_FILTER"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_FILTER_FIELD_UNKNOWN"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_FILTER_OPERATOR"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_FILTER_VALUE"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_FILTER_VALUE_TYPE"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Contacts","scopeId":"SCOPE.DC-CONTACTS.READ-CONTACTS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.QueryContactsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.QueryContactsResponse"},"legacyExamples":[{"name":"QueryContacts","serviceName":"ContactsServiceV4","type":"METHOD","order":2,"content":{"title":"Query Contacts by Amount Spent, Sorted by First Name","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"info.extendedFields.ecom.totalSpentAmount\": {\"$lte\": 50.0 }\n },\n \"sort\": {\n \"fieldName\": \"info.name.last\",\n \"order\" : \"ASC\"\n },\n \"fields\": [\"info.name\", \"info.extendedFields\"],\n \"paging\": {\n \"limit\": 30,\n \"offset\": 30\n }\n }\n }'","response":"{\n \"contacts\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"info\": {\n \"name\": {\n \"first\": \"Anabelle\",\n \"last\": \"Smith\"\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"emailSubscriptions.subscriptionStatus\": \"SUBSCRIBED\",\n \"emailSubscriptions.deliverabilityStatus\": \"ACTIVE\",\n \"emailSubscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 40.0,\n \"ecom.totalSpentCurrency\": \"USD\",\n \"ecom.lastPurchaseDate\": \"2018-10-30T17:22:10.299Z\"\n }\n }\n }\n },\n {\n \"id\": \"e50c4534-d0a5-11ea-87d0-0242ac130003\",\n \"revision\": 1,\n \"info\": {\n \"name\": {\n \"first\": \"Jane\",\n \"last\": \"Smith\"\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Green\",\n \"custom.number\": 1984,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"subscriptions.subscriptionStatus\": \"NOT SET\",\n \"subscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 18,\n \"ecom.totalSpentCurrency\": \"EUR\",\n \"ecom.lastPurchaseDate\": \"2018-12-30T17:22:10.299Z\"\n }\n }\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": 30,\n \"total\": 32\n }\n}"}},{"name":"QueryContacts","serviceName":"ContactsServiceV4","type":"METHOD","order":3,"content":{"title":"Query Contacts by Email","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"query\": {\n \"filter\": {\"info.emails.email\": \"email2@example.com\"},\n \"fieldsets\": [\"BASIC\",\"COMMUNICATION_DETAILS\"]\n }\n }'","response":"{\n \"contacts\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Anabelle\",\n \"last\": \"Smith\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\"\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"total\": 1\n }\n}"}},{"name":"QueryContacts","serviceName":"ContactsServiceV4","type":"METHOD","order":1,"content":{"title":"Query Contacts by Last Name","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"info.name.last\": \"Smith\"\n },\n \"fieldsets\": [\"BASIC\"]\n }\n }'","response":"{\n \"contacts\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Smith\"\n }\n }\n },\n {\n \"id\": \"e50c4534-d0a5-11ea-87d0-0242ac130003\",\n \"revision\": 1,\n \"primaryInfo\": {\n \"email\": \"email211@example.com\",\n \"phone\": \"097499991\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Jane\",\n \"last\": \"Smith\"\n }\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v4/contacts/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_SORT_FIELD"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"ILLEGAL_LIMIT"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"MALFORMED_FILTER"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_FILTER"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_FILTER_FIELD_UNKNOWN"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_FILTER_OPERATOR"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_FILTER_VALUE"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_FILTER_VALUE_TYPE"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Contacts","scopeId":"SCOPE.DC-CONTACTS.READ-CONTACTS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.QueryContactsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.QueryContactsResponse"},"legacyExamples":[{"name":"QueryContacts","serviceName":"ContactsServiceV4","type":"METHOD","order":2,"content":{"title":"Query Contacts by Amount Spent, Sorted by First Name","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"info.extendedFields.ecom.totalSpentAmount\": {\"$lte\": 50.0 }\n },\n \"sort\": {\n \"fieldName\": \"info.name.last\",\n \"order\" : \"ASC\"\n },\n \"fields\": [\"info.name\", \"info.extendedFields\"],\n \"paging\": {\n \"limit\": 30,\n \"offset\": 30\n }\n }\n }'","response":"{\n \"contacts\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"info\": {\n \"name\": {\n \"first\": \"Anabelle\",\n \"last\": \"Smith\"\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"emailSubscriptions.subscriptionStatus\": \"SUBSCRIBED\",\n \"emailSubscriptions.deliverabilityStatus\": \"ACTIVE\",\n \"emailSubscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 40.0,\n \"ecom.totalSpentCurrency\": \"USD\",\n \"ecom.lastPurchaseDate\": \"2018-10-30T17:22:10.299Z\"\n }\n }\n }\n },\n {\n \"id\": \"e50c4534-d0a5-11ea-87d0-0242ac130003\",\n \"revision\": 1,\n \"info\": {\n \"name\": {\n \"first\": \"Jane\",\n \"last\": \"Smith\"\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Green\",\n \"custom.number\": 1984,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"subscriptions.subscriptionStatus\": \"NOT SET\",\n \"subscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 18,\n \"ecom.totalSpentCurrency\": \"EUR\",\n \"ecom.lastPurchaseDate\": \"2018-12-30T17:22:10.299Z\"\n }\n }\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": 30,\n \"total\": 32\n }\n}"}},{"name":"QueryContacts","serviceName":"ContactsServiceV4","type":"METHOD","order":3,"content":{"title":"Query Contacts by Email","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"query\": {\n \"filter\": {\"info.emails.email\": \"email2@example.com\"},\n \"fieldsets\": [\"BASIC\",\"COMMUNICATION_DETAILS\"]\n }\n }'","response":"{\n \"contacts\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Anabelle\",\n \"last\": \"Smith\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\"\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"total\": 1\n }\n}"}},{"name":"QueryContacts","serviceName":"ContactsServiceV4","type":"METHOD","order":1,"content":{"title":"Query Contacts by Last Name","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts/query' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"info.name.last\": \"Smith\"\n },\n \"fieldsets\": [\"BASIC\"]\n }\n }'","response":"{\n \"contacts\": [\n {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Smith\"\n }\n }\n },\n {\n \"id\": \"e50c4534-d0a5-11ea-87d0-0242ac130003\",\n \"revision\": 1,\n \"primaryInfo\": {\n \"email\": \"email211@example.com\",\n \"phone\": \"097499991\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Jane\",\n \"last\": \"Smith\"\n }\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Query Contacts","slugifiedName":"query-contacts"}},{"summary":"List Facets","description":"Lists facets from the site’s Contact List.\nFacets are labels and subscription statuses.\nEach facet returns its details (such as `key` and `value`),\nas well as aggregated `count` of the number of contacts\nthe facet applies to.","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.ListFacets","parameters":[{"name":"paging","in":"query","description":"Allow paginating, default: offset = 0 and limit = 1000","required":false,"schema":{"description":"Allow paginating, default: offset = 0 and limit = 1000","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"language","in":"query","description":"Language for localization","required":false,"schema":{"description":"Language for localization","format":"LANGUAGE","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ListFacetsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Contacts","scopeId":"SCOPE.DC-CONTACTS.READ-CONTACTS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.ListFacetsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.ListFacetsResponse"},"legacyExamples":[{"name":"ListFacets","serviceName":"ContactsServiceV4","type":"METHOD","order":1,"content":{"title":"List Facets","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts/facets' \\\n -H 'Authorization: '","response":"{\n \"facets\": [\n {\n \"facetType\": \"ALL_CONTACTS\",\n \"facetKey\": \"contacts.all\",\n \"facetDisplayName\": \"All Contacts\",\n \"count\": 20,\n \"legacyId\": \"contacts-all\"\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"facetKey\": \"custom.label1\",\n \"facetDisplayName\": \"label1\",\n \"count\": 0,\n \"legacyId\": \"3b2af9cd-fa9e-4084-9c87-0a3d660cb2c9\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"custom.label1\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"facetKey\": \"custom.label2\",\n \"facetDisplayName\": \"label2\",\n \"count\": 1,\n \"legacyId\": \"66fa243c-97ad-4891-b628-fcd2d1d5cbe0\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"custom.label2\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"factKey\": \"contacts.customers\",\n \"facetDisplayName\": \"Customers\",\n \"count\": 0,\n \"legacyId\": \"contacts-customers\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"contacts.customers\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"facetKey\": \"contacts.contacted-me\",\n \"facetDisplayName\": \"Contacted Me\",\n \"count\": 1,\n \"legacyId\": \"contacts-contacted_me\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"contacts.contacted-me\"]}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.subscribed\",\n \"facetDisplayName\": \"Subscribed\",\n \"count\": 1,\n \"legacyId\": \"contacts-subscribed\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"SUBSCRIBED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.unsubscribed\",\n \"facetDisplayName\": \"Unsubscribed\",\n \"count\": 1,\n \"legacyId\": \"contacts-unsubscribed\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"UNSUBSCRIBED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.pending\",\n \"facetDisplayName\": \"Pending\",\n \"count\": 0,\n \"legacyId\": \"contacts-pending-subscription\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"PENDING\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.bounced\",\n \"facetDisplayName\": \"Bounced\",\n \"count\": 3,\n \"legacyId\": \"contacts-delivery_all_non_valid\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"BOUNCED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.spam\",\n \"facetDisplayName\": \"Spam\",\n \"count\": 0,\n \"legacyId\": \"contacts-delivery_spam\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"SPAM_COMPLAINT\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.inactive\",\n \"facetDisplayName\": \"Inactive\",\n \"count\": 0,\n \"legacyId\": \"contacts-delivery_inactive\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"INACTIVE\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.approved\",\n \"facetDisplayName\": \"Approved\",\n \"count\": 1,\n \"legacyId\": \"contacts-site_members_approved\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"APPROVED\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.denied\",\n \"facetDisplayName\": \"Blocked\",\n \"count\": 1,\n \"legacyId\": \"contacts-site_members_denied\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"DENIED\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.pending\",\n \"facetDisplayName\": \"Pending\",\n \"count\": 2,\n \"legacyId\": \"contacts-site_members_request\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"PENDING\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.inactive\",\n \"facetDisplayName\": \"Inactive\",\n \"count\": 0,\n \"legacyId\": \"contacts-site_members_inactive\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"INACTIVE\"}}\n }\n ],\n \"pagingMetadata\": {\n \"count\": 15,\n \"offset\": 0,\n \"total\": 15\n }\n}"}},{"name":"ListFacets","serviceName":"ContactsServiceV4","type":"METHOD","order":2,"content":{"title":"List Facets in Spanish","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts/facets?language=es' \\\n -H 'Authorization: '","response":"{\n \"facets\": [\n {\n \"facetType\": \"ALL_CONTACTS\",\n \"facetKey\": \"contacts.all\",\n \"facetDisplayName\": \"Todos los contactos\",\n \"count\": 20,\n \"legacyId\": \"contacts-all\"\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"custom\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"facetKey\": \"custom.label1\",\n \"facetDisplayName\": \"label1\",\n \"count\": 0,\n \"legacyId\": \"3b2af9cd-fa9e-4084-9c87-0a3d660cb2c9\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"custom.label1\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"custom\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"facetKey\": \"custom.label2\",\n \"facetDisplayName\": \"label2\",\n \"count\": 1,\n \"legacyId\": \"66fa243c-97ad-4891-b628-fcd2d1d5cbe0\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"custom.label2\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"contacts\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"factKey\": \"contacts.customers\",\n \"facetDisplayName\": \"Clientes\",\n \"count\": 0,\n \"legacyId\": \"contacts-customers\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"contacts.customers\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"contacts\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"facetKey\": \"contacts.contacted-me\",\n \"facetDisplayName\": \"Me contactaron\",\n \"count\": 1,\n \"legacyId\": \"contacts-contacted_me\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"contacts.contacted-me\"]}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Estado de la suscripción de correo electrónico\",\n \"facetKey\": \"emailSubscriptions.subscribed\",\n \"facetDisplayName\": \"Suscritos\",\n \"count\": 1,\n \"legacyId\": \"contacts-subscribed\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"SUBSCRIBED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Estado de la suscripción de correo electrónico\",\n \"facetKey\": \"emailSubscriptions.unsubscribed\",\n \"facetDisplayName\": \"Dados de baja\",\n \"count\": 1,\n \"legacyId\": \"contacts-unsubscribed\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"UNSUBSCRIBED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Estado de la suscripción de correo electrónico\",\n \"facetKey\": \"emailSubscriptions.pending\",\n \"facetDisplayName\": \"Pendientes\",\n \"count\": 0,\n \"legacyId\": \"contacts-pending-subscription\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"PENDING\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Estado de la suscripción de correo electrónico\",\n \"facetKey\": \"emailSubscriptions.bounced\",\n \"facetDisplayName\": \"Rechazados\",\n \"count\": 3,\n \"legacyId\": \"contacts-delivery_all_non_valid\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"BOUNCED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Estado de la suscripción de correo electrónico\",\n \"facetKey\": \"emailSubscriptions.spam\",\n \"facetDisplayName\": \"Spam\",\n \"count\": 0,\n \"legacyId\": \"contacts-delivery_spam\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"SPAM_COMPLAINT\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Estado de la suscripción de correo electrónico\",\n \"facetKey\": \"emailSubscriptions.inactive\",\n \"facetDisplayName\": \"Inactivos\",\n \"count\": 0,\n \"legacyId\": \"contacts-delivery_inactive\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"INACTIVE\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Estado miembro\",\n \"facetKey\": \"membershipStatus.approved\",\n \"facetDisplayName\": \"Aprobada\",\n \"count\": 1,\n \"legacyId\": \"contacts-site_members_approved\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"APPROVED\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Estado miembro\",\n \"facetKey\": \"membershipStatus.denied\",\n \"facetDisplayName\": \"Obstruida\",\n \"count\": 1,\n \"legacyId\": \"contacts-site_members_denied\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"DENIED\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Estado miembro\",\n \"facetKey\": \"membershipStatus.pending\",\n \"facetDisplayName\": \"Pendiente\",\n \"count\": 2,\n \"legacyId\": \"contacts-site_members_request\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"PENDING\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Estado miembro\",\n \"facetKey\": \"membershipStatus.inactive\",\n \"facetDisplayName\": \"Inactiva\",\n \"count\": 0,\n \"legacyId\": \"contacts-site_members_inactive\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"INACTIVE\"}}\n }\n ],\n \"pagingMetadata\": {\n \"count\": 15,\n \"offset\": 0,\n \"total\": 15\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"get","path":"/v4/contacts/facets","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Contacts","scopeId":"SCOPE.DC-CONTACTS.READ-CONTACTS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.ListFacetsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.ListFacetsResponse"},"legacyExamples":[{"name":"ListFacets","serviceName":"ContactsServiceV4","type":"METHOD","order":1,"content":{"title":"List Facets","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts/facets' \\\n -H 'Authorization: '","response":"{\n \"facets\": [\n {\n \"facetType\": \"ALL_CONTACTS\",\n \"facetKey\": \"contacts.all\",\n \"facetDisplayName\": \"All Contacts\",\n \"count\": 20,\n \"legacyId\": \"contacts-all\"\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"facetKey\": \"custom.label1\",\n \"facetDisplayName\": \"label1\",\n \"count\": 0,\n \"legacyId\": \"3b2af9cd-fa9e-4084-9c87-0a3d660cb2c9\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"custom.label1\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"facetKey\": \"custom.label2\",\n \"facetDisplayName\": \"label2\",\n \"count\": 1,\n \"legacyId\": \"66fa243c-97ad-4891-b628-fcd2d1d5cbe0\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"custom.label2\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"factKey\": \"contacts.customers\",\n \"facetDisplayName\": \"Customers\",\n \"count\": 0,\n \"legacyId\": \"contacts-customers\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"contacts.customers\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"facetKey\": \"contacts.contacted-me\",\n \"facetDisplayName\": \"Contacted Me\",\n \"count\": 1,\n \"legacyId\": \"contacts-contacted_me\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"contacts.contacted-me\"]}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.subscribed\",\n \"facetDisplayName\": \"Subscribed\",\n \"count\": 1,\n \"legacyId\": \"contacts-subscribed\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"SUBSCRIBED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.unsubscribed\",\n \"facetDisplayName\": \"Unsubscribed\",\n \"count\": 1,\n \"legacyId\": \"contacts-unsubscribed\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"UNSUBSCRIBED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.pending\",\n \"facetDisplayName\": \"Pending\",\n \"count\": 0,\n \"legacyId\": \"contacts-pending-subscription\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"PENDING\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.bounced\",\n \"facetDisplayName\": \"Bounced\",\n \"count\": 3,\n \"legacyId\": \"contacts-delivery_all_non_valid\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"BOUNCED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.spam\",\n \"facetDisplayName\": \"Spam\",\n \"count\": 0,\n \"legacyId\": \"contacts-delivery_spam\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"SPAM_COMPLAINT\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.inactive\",\n \"facetDisplayName\": \"Inactive\",\n \"count\": 0,\n \"legacyId\": \"contacts-delivery_inactive\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"INACTIVE\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.approved\",\n \"facetDisplayName\": \"Approved\",\n \"count\": 1,\n \"legacyId\": \"contacts-site_members_approved\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"APPROVED\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.denied\",\n \"facetDisplayName\": \"Blocked\",\n \"count\": 1,\n \"legacyId\": \"contacts-site_members_denied\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"DENIED\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.pending\",\n \"facetDisplayName\": \"Pending\",\n \"count\": 2,\n \"legacyId\": \"contacts-site_members_request\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"PENDING\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.inactive\",\n \"facetDisplayName\": \"Inactive\",\n \"count\": 0,\n \"legacyId\": \"contacts-site_members_inactive\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"INACTIVE\"}}\n }\n ],\n \"pagingMetadata\": {\n \"count\": 15,\n \"offset\": 0,\n \"total\": 15\n }\n}"}},{"name":"ListFacets","serviceName":"ContactsServiceV4","type":"METHOD","order":2,"content":{"title":"List Facets in Spanish","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts/facets?language=es' \\\n -H 'Authorization: '","response":"{\n \"facets\": [\n {\n \"facetType\": \"ALL_CONTACTS\",\n \"facetKey\": \"contacts.all\",\n \"facetDisplayName\": \"Todos los contactos\",\n \"count\": 20,\n \"legacyId\": \"contacts-all\"\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"custom\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"facetKey\": \"custom.label1\",\n \"facetDisplayName\": \"label1\",\n \"count\": 0,\n \"legacyId\": \"3b2af9cd-fa9e-4084-9c87-0a3d660cb2c9\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"custom.label1\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"custom\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"facetKey\": \"custom.label2\",\n \"facetDisplayName\": \"label2\",\n \"count\": 1,\n \"legacyId\": \"66fa243c-97ad-4891-b628-fcd2d1d5cbe0\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"custom.label2\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"contacts\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"factKey\": \"contacts.customers\",\n \"facetDisplayName\": \"Clientes\",\n \"count\": 0,\n \"legacyId\": \"contacts-customers\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"contacts.customers\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"contacts\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"facetKey\": \"contacts.contacted-me\",\n \"facetDisplayName\": \"Me contactaron\",\n \"count\": 1,\n \"legacyId\": \"contacts-contacted_me\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"contacts.contacted-me\"]}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Estado de la suscripción de correo electrónico\",\n \"facetKey\": \"emailSubscriptions.subscribed\",\n \"facetDisplayName\": \"Suscritos\",\n \"count\": 1,\n \"legacyId\": \"contacts-subscribed\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"SUBSCRIBED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Estado de la suscripción de correo electrónico\",\n \"facetKey\": \"emailSubscriptions.unsubscribed\",\n \"facetDisplayName\": \"Dados de baja\",\n \"count\": 1,\n \"legacyId\": \"contacts-unsubscribed\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"UNSUBSCRIBED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Estado de la suscripción de correo electrónico\",\n \"facetKey\": \"emailSubscriptions.pending\",\n \"facetDisplayName\": \"Pendientes\",\n \"count\": 0,\n \"legacyId\": \"contacts-pending-subscription\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"PENDING\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Estado de la suscripción de correo electrónico\",\n \"facetKey\": \"emailSubscriptions.bounced\",\n \"facetDisplayName\": \"Rechazados\",\n \"count\": 3,\n \"legacyId\": \"contacts-delivery_all_non_valid\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"BOUNCED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Estado de la suscripción de correo electrónico\",\n \"facetKey\": \"emailSubscriptions.spam\",\n \"facetDisplayName\": \"Spam\",\n \"count\": 0,\n \"legacyId\": \"contacts-delivery_spam\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"SPAM_COMPLAINT\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Estado de la suscripción de correo electrónico\",\n \"facetKey\": \"emailSubscriptions.inactive\",\n \"facetDisplayName\": \"Inactivos\",\n \"count\": 0,\n \"legacyId\": \"contacts-delivery_inactive\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"INACTIVE\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Estado miembro\",\n \"facetKey\": \"membershipStatus.approved\",\n \"facetDisplayName\": \"Aprobada\",\n \"count\": 1,\n \"legacyId\": \"contacts-site_members_approved\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"APPROVED\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Estado miembro\",\n \"facetKey\": \"membershipStatus.denied\",\n \"facetDisplayName\": \"Obstruida\",\n \"count\": 1,\n \"legacyId\": \"contacts-site_members_denied\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"DENIED\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Estado miembro\",\n \"facetKey\": \"membershipStatus.pending\",\n \"facetDisplayName\": \"Pendiente\",\n \"count\": 2,\n \"legacyId\": \"contacts-site_members_request\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"PENDING\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Estado miembro\",\n \"facetKey\": \"membershipStatus.inactive\",\n \"facetDisplayName\": \"Inactiva\",\n \"count\": 0,\n \"legacyId\": \"contacts-site_members_inactive\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"INACTIVE\"}}\n }\n ],\n \"pagingMetadata\": {\n \"count\": 15,\n \"offset\": 0,\n \"total\": 15\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"List Facets","slugifiedName":"list-facets"}},{"summary":"Query Facets","description":"Retrieves facets from the site’s Contact List by filter.\nFacets are labels and subscription statuses.\nEach facet returns its details (such as `key` and `value`),\nas well as aggregated `count` of the number of contacts\nthe facet applies to.","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.QueryFacets","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.QueryFacetsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryFacetsRequest","description":"","properties":{"paging":{"description":"Allow paginating, default: offset = 0 and limit = 1000","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language for localization","format":"LANGUAGE","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filter":{"description":"Only allowed fields:\n#info.extendedFields.emailSubscriptions.effectiveEmail ($exists)\n#info.extendedFields.emailSubscriptions.subscriptionStatus ($eq, $ne, $in, $nin)\n#info.extendedFields.emailSubscriptions.deliverabilityStatus ($eq, $ne, $in, $nin)","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Contacts","scopeId":"SCOPE.DC-CONTACTS.READ-CONTACTS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.QueryFacetsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.QueryFacetsResponse"},"legacyExamples":[{"name":"QueryFacets","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Query Facets for Contacts with Effective Email","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts/facets' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"queryFilter\": {\n \"$and\": [\n {\"info.extendedFields.emailSubscriptions.effectiveEmail\": {\"$exists\": true}},\n {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\": {\"$in\": [\"VALID\", \"INACTIVE\"]}}\n ]\n }\n }'","response":"{\n \"facets\": [\n {\n \"facetType\": \"ALL_CONTACTS\",\n \"facetKey\": \"contacts.all\",\n \"facetDisplayName\": \"All Contacts\",\n \"count\": 8,\n \"legacyId\": \"contacts-all\"\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"facetKey\": \"custom.label1\",\n \"facetDisplayName\": \"label1\",\n \"count\": 0,\n \"legacyId\": \"3b2af9cd-fa9e-4084-9c87-0a3d660cb2c9\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"custom.label1\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"facetKey\": \"custom.label2\",\n \"facetDisplayName\": \"label2\",\n \"count\": 1,\n \"legacyId\": \"66fa243c-97ad-4891-b628-fcd2d1d5cbe0\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"custom.label2\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"factKey\": \"contacts.customers\",\n \"facetDisplayName\": \"Customers\",\n \"count\": 0,\n \"legacyId\": \"contacts-customers\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"contacts.customers\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"facetKey\": \"contacts.contacted-me\",\n \"facetDisplayName\": \"Contacted Me\",\n \"count\": 1,\n \"legacyId\": \"contacts-contacted_me\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"contacts.contacted-me\"]}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.subscribed\",\n \"facetDisplayName\": \"Subscribed\",\n \"count\": 1,\n \"legacyId\": \"contacts-subscribed\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"SUBSCRIBED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.unsubscribed\",\n \"facetDisplayName\": \"Unsubscribed\",\n \"count\": 1,\n \"legacyId\": \"contacts-unsubscribed\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"UNSUBSCRIBED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.pending\",\n \"facetDisplayName\": \"Pending\",\n \"count\": 0,\n \"legacyId\": \"contacts-pending-subscription\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"PENDING\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.bounced\",\n \"facetDisplayName\": \"Bounced\",\n \"count\": 0,\n \"legacyId\": \"contacts-delivery_all_non_valid\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"BOUNCED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.spam\",\n \"facetDisplayName\": \"Spam\",\n \"count\": 0,\n \"legacyId\": \"contacts-delivery_spam\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"SPAM_COMPLAINT\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.inactive\",\n \"facetDisplayName\": \"Inactive\",\n \"count\": 0,\n \"legacyId\": \"contacts-delivery_inactive\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"INACTIVE\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.approved\",\n \"facetDisplayName\": \"Approved\",\n \"count\": 1,\n \"legacyId\": \"contacts-site_members_approved\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"APPROVED\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.denied\",\n \"facetDisplayName\": \"Blocked\",\n \"count\": 1,\n \"legacyId\": \"contacts-site_members_denied\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"DENIED\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.pending\",\n \"facetDisplayName\": \"Pending\",\n \"count\": 2,\n \"legacyId\": \"contacts-site_members_request\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"PENDING\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.inactive\",\n \"facetDisplayName\": \"Inactive\",\n \"count\": 0,\n \"legacyId\": \"contacts-site_members_inactive\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"INACTIVE\"}}\n }\n ],\n \"pagingMetadata\": {\n \"count\": 15,\n \"offset\": 0,\n \"total\": 15\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v4/contacts/facets/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Contacts","scopeId":"SCOPE.DC-CONTACTS.READ-CONTACTS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.QueryFacetsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.QueryFacetsResponse"},"legacyExamples":[{"name":"QueryFacets","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Query Facets for Contacts with Effective Email","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/contacts/facets' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"queryFilter\": {\n \"$and\": [\n {\"info.extendedFields.emailSubscriptions.effectiveEmail\": {\"$exists\": true}},\n {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\": {\"$in\": [\"VALID\", \"INACTIVE\"]}}\n ]\n }\n }'","response":"{\n \"facets\": [\n {\n \"facetType\": \"ALL_CONTACTS\",\n \"facetKey\": \"contacts.all\",\n \"facetDisplayName\": \"All Contacts\",\n \"count\": 8,\n \"legacyId\": \"contacts-all\"\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"facetKey\": \"custom.label1\",\n \"facetDisplayName\": \"label1\",\n \"count\": 0,\n \"legacyId\": \"3b2af9cd-fa9e-4084-9c87-0a3d660cb2c9\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"custom.label1\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"facetKey\": \"custom.label2\",\n \"facetDisplayName\": \"label2\",\n \"count\": 1,\n \"legacyId\": \"66fa243c-97ad-4891-b628-fcd2d1d5cbe0\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"custom.label2\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"factKey\": \"contacts.customers\",\n \"facetDisplayName\": \"Customers\",\n \"count\": 0,\n \"legacyId\": \"contacts-customers\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"contacts.customers\"]}}\n },\n {\n \"facetType\": \"LABELS\",\n \"namespace\": \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"facetKey\": \"contacts.contacted-me\",\n \"facetDisplayName\": \"Contacted Me\",\n \"count\": 1,\n \"legacyId\": \"contacts-contacted_me\",\n \"queryFilter\": {\"info.labelKeys\" : {\"$hasSome\": [\"contacts.contacted-me\"]}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.subscribed\",\n \"facetDisplayName\": \"Subscribed\",\n \"count\": 1,\n \"legacyId\": \"contacts-subscribed\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"SUBSCRIBED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.unsubscribed\",\n \"facetDisplayName\": \"Unsubscribed\",\n \"count\": 1,\n \"legacyId\": \"contacts-unsubscribed\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"UNSUBSCRIBED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.pending\",\n \"facetDisplayName\": \"Pending\",\n \"count\": 0,\n \"legacyId\": \"contacts-pending-subscription\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.subscriptionStatus\" : {\"$eq\": \"PENDING\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.bounced\",\n \"facetDisplayName\": \"Bounced\",\n \"count\": 0,\n \"legacyId\": \"contacts-delivery_all_non_valid\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"BOUNCED\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.spam\",\n \"facetDisplayName\": \"Spam\",\n \"count\": 0,\n \"legacyId\": \"contacts-delivery_spam\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"SPAM_COMPLAINT\"}}\n },\n {\n \"facetType\": \"SUBSCRIPTION_STATUS\",\n \"namespace\": \"emailSubscriptions\",\n \"namespaceDisplayName\": \"Email Subscription Status\",\n \"facetKey\": \"emailSubscriptions.inactive\",\n \"facetDisplayName\": \"Inactive\",\n \"count\": 0,\n \"legacyId\": \"contacts-delivery_inactive\",\n \"queryFilter\": {\"info.extendedFields.emailSubscriptions.deliverabilityStatus\" : {\"$eq\": \"INACTIVE\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.approved\",\n \"facetDisplayName\": \"Approved\",\n \"count\": 1,\n \"legacyId\": \"contacts-site_members_approved\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"APPROVED\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.denied\",\n \"facetDisplayName\": \"Blocked\",\n \"count\": 1,\n \"legacyId\": \"contacts-site_members_denied\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"DENIED\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.pending\",\n \"facetDisplayName\": \"Pending\",\n \"count\": 2,\n \"legacyId\": \"contacts-site_members_request\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"PENDING\"}}\n },\n {\n \"facetType\": \"MEMBERSHIP_STATUS\",\n \"namespace\": \"membershipStatus\",\n \"namespaceDisplayName\": \"Membership Status\",\n \"facetKey\": \"membershipStatus.inactive\",\n \"facetDisplayName\": \"Inactive\",\n \"count\": 0,\n \"legacyId\": \"contacts-site_members_inactive\",\n \"queryFilter\": {\"info.extendedFields.members.membershipStatus\" : {\"$eq\": \"INACTIVE\"}}\n }\n ],\n \"pagingMetadata\": {\n \"count\": 15,\n \"offset\": 0,\n \"total\": 15\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Query Facets","slugifiedName":"query-facets"}},{"summary":"Bulk Delete Contacts","description":"Deletes multiple contacts.\n\nAll contacts that meet the specified `filter` and `search` criteria are deleted.\nThe request should contain a `filter` value or a `search` value, or both.\nTo perform a dry run, use the intended filter options with\n[Query Contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts).\n\nWhen this endpoint is used, a bulk job is started and the job ID is returned.\nThe job might not complete right away, depending on its size.\nThe job's status can be retrieved with\n[Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n[List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).\n\nThe following errors can happen while processing the bulk and they will appear in the bulk job:\n- `CANNOT_DELETE_SITE_MEMBERS` - Contact is a site member and cannot be deleted. Member must be deleted first.\n- `CANNOT_DELETE_CONTACT_WITH_BILLING_SUBSCRIPTION` - Contact has a valid billing subscription and cannot be deleted.\n- `CANNOT_DELETE_MEMBER_OWNER_OR_CONTRIBUTOR` - Member cannot be deleted because it is the owner or a contributor. This can happen only if the request indicated to delete the member.\n- `FAILED_DELETE_CONTACT_AFTER_MEMBER_DELETION` - Member was deleted, but contact was not. This can happen only if the request indicated to delete the member.\n- `FAILED_DELETE_CONTACT` - Contact could not be deleted.","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.BulkDeleteContacts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.BulkDeleteContactsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/bulk","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/bulk","destinationPath":"/v4/bulk","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkDeleteContactsRequest","description":"","properties":{"filter":{"description":"Filter object.\n\nPossible filters:\n`$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.\n\nFor a detailed list of supported filters, see\nfiltering and sorting for\n[contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),\n[extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),\nand [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).\n\nExample:\n`{ \"filter\": { \"info.name.last\": \"Smith\" } }`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Plain text search for an exact match, up to 100 characters.\n\nSearchable fields:\n\n- `info.name.first`\n- `info.name.last`\n- `info.emails.email`\n- `info.phones.phone`","maxLength":100,"title":"search","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Contact Deleted","description":"Triggered when a contact is deleted.","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_deleted","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"NEITHER_FILTER_NOR_SEARCH"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY","MEMBERS.MEMBER_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.BulkDeleteContactsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.BulkDeleteContactsResponse"},"legacyExamples":[{"name":"BulkDeleteContacts","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Bulk Delete Contacts","description":"Deletes all contacts with last name \"Smith\".","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/bulk/contacts/delete' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"filter\": {\n \"info.name.last\": \"Smith\"\n }\n }'","response":"{\n \"jobId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v4/bulk/contacts/delete","rpcOnly":false,"triggeredEvents":[{"title":"Contact Deleted","description":"Triggered when a contact is deleted.","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_deleted","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"NEITHER_FILTER_NOR_SEARCH"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY","MEMBERS.MEMBER_DELETE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Members","scopeId":"SCOPE.DC-MEMBERS.MANAGE-MEMBERS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.BulkDeleteContactsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.BulkDeleteContactsResponse"},"legacyExamples":[{"name":"BulkDeleteContacts","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Bulk Delete Contacts","description":"Deletes all contacts with last name \"Smith\".","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/bulk/contacts/delete' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"filter\": {\n \"info.name.last\": \"Smith\"\n }\n }'","response":"{\n \"jobId\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\"\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Bulk Delete Contacts","slugifiedName":"bulk-delete-contacts"}},{"summary":"Bulk Update Contacts","description":"

\n\n__Deprecation Notice:__\n\nThis method will be removed on Nov 30, 2024. If your app uses this method, we recommend updating your code as soon as possible.\n\n

\n\nUpdates the specified properties for multiple contacts.\nFields that are included in fieldMask.paths are updated,\nwhile all other fields stay the same.\n\nAll contacts that meet the specified `filter` and `search` criteria are updated.\nTo perform a dry run, use the intended filter options with\n[Query Contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts).\n\nWhen this endpoint is used, a bulk job is started and the job ID is returned.\nThe job may not complete right away, depending on its size.\nThe job's status can be retrieved with\n[Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n[List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.BulkUpdateContacts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.BulkUpdateContactsResponse","description":""}},"deprecated":true,"servers":[{"url":"https://www.wixapis.com/contacts/v4/bulk","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/bulk","destinationPath":"/v4/bulk","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkUpdateContactsRequest","description":"","properties":{"filter":{"description":"Filter object.\n\nPossible filters:\n`$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.\n\nFor a detailed list of supported filters, see\nfiltering and sorting for\n[contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),\n[extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),\nand [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).\n\nExample:\n`{ \"filter\": { \"info.name.last\": \"Smith\" } }`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Plain text search for an exact match, up to 100 characters.\n\nSearchable fields:\n\n- `info.name.first`\n- `info.name.last`\n- `info.emails.email`\n- `info.phones.phone`","maxLength":100,"title":"search","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"info":{"description":"Contact info.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactInfo","summary":"info","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}},"x-wix-docs":{"deprecated":{"targetRemovalDate":"2024-11-30"}}},"x-wix-docs":{"triggeredEvents":[{"title":"Contact Updated","description":"","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_updated","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.BulkUpdateContactsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.BulkUpdateContactsResponse"},"deprecated":{"targetRemovalDate":"2024-11-30"},"legacyExamples":[{"name":"BulkUpdateContacts","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Bulk Update Contacts","description":"Updates last name and company for all contacts with first name \"John\".","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/bulk/contacts/update' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"filter\": {\n \"info.name.first\": \"John\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Changed\"\n },\n \"company\": \"Wix\",\n },\n \"fieldMask\": {\n \"paths\": [\n \"info.company\",\n \"info.name.last\"\n ]\n }\n }'","response":"{\n \"jobId\": \"8046df3c-1234-0aa7-a5ab-c91ad8f33c47\"\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v4/bulk/contacts/update","rpcOnly":false,"triggeredEvents":[{"title":"Contact Updated","description":"","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_updated","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.BulkUpdateContactsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.BulkUpdateContactsResponse"},"legacyExamples":[{"name":"BulkUpdateContacts","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Bulk Update Contacts","description":"Updates last name and company for all contacts with first name \"John\".","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/bulk/contacts/update' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"filter\": {\n \"info.name.first\": \"John\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Changed\"\n },\n \"company\": \"Wix\",\n },\n \"fieldMask\": {\n \"paths\": [\n \"info.company\",\n \"info.name.last\"\n ]\n }\n }'","response":"{\n \"jobId\": \"8046df3c-1234-0aa7-a5ab-c91ad8f33c47\"\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Bulk Update Contacts","slugifiedName":"bulk-update-contacts"},"deprecationDetails":{"targetRemovalDate":"2024-11-30"}},{"summary":"Bulk Label And Unlabel Contacts","description":"Adds and removes labels from multiple contacts.\n\nLabels are added to and removed from all contacts that meet the specified\n`filter` and `search` criteria.\nThe request should contain a `filter` value or a `search` value, or both. To perform a dry run, use the intended filter options with\n[Query Contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts).\n\nWhen this endpoint is used, a bulk job is started and the job ID is returned.\nThe job might not not complete right away, depending on its size.\nThe job's status can be retrieved with\n[Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n[List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.BulkLabelAndUnlabelContacts","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.BulkLabelAndUnlabelContactsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/bulk","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/bulk","destinationPath":"/v4/bulk","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"BulkLabelAndUnlabelContactsRequest","description":"","properties":{"filter":{"description":"Filter options.\nLabels will be removed from contacts that meet the `filter` and `search` criteria.\n\nSee\n[Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter#contacts_contacts_sort-and-filter_field-support-for-filtering-sorting-and-searching)\nfor a list of supported filters and fields.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Plain text search for an exact match, up to 100 characters.\nLabels will be removed from contacts that meet the `filter` and `search` criteria.\n\nSee\n[Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter#contacts_contacts_sort-and-filter_field-support-for-filtering-sorting-and-searching)\nfor a list of searchable fields.","maxLength":100,"title":"search","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"labelKeysToAdd":{"description":"List of label keys to add to the contacts.\n\nLabel keys must exist to be added to the contact.\nContact labels can be created or retrieved with\n[Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)\nor\n[List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)","maxItems":100,"title":"labelKeysToAdd","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"labelKeysToRemove":{"description":"List of label keys to remove from the contacts.","maxItems":100,"title":"labelKeysToRemove","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Contact Updated","description":"Triggered when a contact is updated.\n\nIf a contact is updated as part of a merge,\nthe `originatedFrom` property is sent as `merge`.\nOtherwise, `originatedFrom` is omitted.","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_updated","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"NEITHER_FILTER_NOR_SEARCH"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.BulkLabelAndUnlabelContactsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.BulkLabelAndUnlabelContactsResponse"},"legacyExamples":[{"name":"BulkLabelAndUnlabelContacts","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Bulk Add and Remove Contact Labels","description":"Adds and removes labels to/from contacts with first name \"John\".","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/bulk/contacts/add-remove-labels' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"filter\": {\n \"info.name.first\": \"John\"\n },\n \"labelKeysToAdd\": [\"custom.name-john\", \"custom.name-starts-with-J\"],\n \"labelKeysToRemove\": [\"custom.last-name-smith\"]\n }'","response":"{\n \"jobId\": \"8046df3c-1234-4098-a5ab-c91ad8f33c47\"\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v4/bulk/contacts/add-remove-labels","rpcOnly":false,"triggeredEvents":[{"title":"Contact Updated","description":"Triggered when a contact is updated.\n\nIf a contact is updated as part of a merge,\nthe `originatedFrom` property is sent as `merge`.\nOtherwise, `originatedFrom` is omitted.","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.contact_updated","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"NEITHER_FILTER_NOR_SEARCH"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.BulkLabelAndUnlabelContactsRequest","responseMessage":"com.wixpress.contacts.core.api.v4.BulkLabelAndUnlabelContactsResponse"},"legacyExamples":[{"name":"BulkLabelAndUnlabelContacts","serviceName":"ContactsServiceV4","type":"METHOD","content":{"title":"Bulk Add and Remove Contact Labels","description":"Adds and removes labels to/from contacts with first name \"John\".","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/bulk/contacts/add-remove-labels' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"filter\": {\n \"info.name.first\": \"John\"\n },\n \"labelKeysToAdd\": [\"custom.name-john\", \"custom.name-starts-with-J\"],\n \"labelKeysToRemove\": [\"custom.last-name-smith\"]\n }'","response":"{\n \"jobId\": \"8046df3c-1234-4098-a5ab-c91ad8f33c47\"\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Bulk Label And Unlabel Contacts","slugifiedName":"bulk-label-and-unlabel-contacts"}},{"summary":"Get Contact","description":"Retrieves a contact.\n\n#### Getting Merged Contacts\n\nWhen a source contact is merged\nwith a target contact, the source contact is deleted.\nWhen calling Get Contact for a merged contact,\nyou can use the source or target contact ID.\nIn both bases, the target contact is returned.\n\nThis is supported only when calling Get Contact,\nand only for merged contacts.\nDeleted source contact IDs are not supported on any other endpoint.\n\nMembers are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.","operationId":"com.wixpress.contacts.core.api.v4.ContactsServiceV4.GetContact","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"id","description":"ID of the contact to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"fields","in":"query","description":"List of projected fields to return.\nIf both `fields` and `fieldsets` are sent in the request,\nthe union of both lists is returned.\n`id` and `revision` are always returned.\n\nSupported properties:\n`source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,\n`info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,\n`info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,\n`info.labelKeys`, `info.locations`, `info.extendedFields`","required":false,"schema":{"description":"List of projected fields to return.\nIf both `fields` and `fieldsets` are sent in the request,\nthe union of both lists is returned.\n`id` and `revision` are always returned.\n\nSupported properties:\n`source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,\n`info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,\n`info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,\n`info.labelKeys`, `info.locations`, `info.extendedFields`","maxLength":100,"maxItems":100,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"fieldsets","in":"query","description":"Predefined sets of fields to return.\nIf both `fields` and `fieldsets` are sent in the request,\nthe union of both lists is returned.\n\n- `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.\n- `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.\n- `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.\n- `FULL`: Returns all fields.\n\nDefault: If `fields` is omitted from the request, `FULL`.","required":false,"schema":{"description":"Predefined sets of fields to return.\nIf both `fields` and `fieldsets` are sent in the request,\nthe union of both lists is returned.\n\n- `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.\n- `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.\n- `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.\n- `FULL`: Returns all fields.\n\nDefault: If `fields` is omitted from the request, `FULL`.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactFieldSet"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.GetContactResponse","description":"The requested contact."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/contacts","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/contacts","destinationPath":"/v4/contacts","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CONTACT_NOT_FOUND"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Contacts","scopeId":"SCOPE.DC-CONTACTS.READ-CONTACTS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.GetContactRequest","responseMessage":"com.wixpress.contacts.core.api.v4.GetContactResponse"},"legacyExamples":[{"name":"GetContact","serviceName":"ContactsServiceV4","type":"METHOD","order":2,"content":{"title":"Get Contact with Projected Fields","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47?fields=source&fields=updatedDate' \\\n -H 'Authorization: '","response":"{\n \"contact\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\"\n },\n \"responseType\" : \"REGULAR\"\n}"}},{"name":"GetContact","serviceName":"ContactsServiceV4","type":"METHOD","order":3,"content":{"title":"Get Contact","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47?fieldsets=BASIC' \\\n -H 'Authorization: '","response":"{\n \"contact\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n }\n }\n },\n \"responseType\" : \"REGULAR\"\n}"}},{"name":"GetContact","serviceName":"ContactsServiceV4","type":"METHOD","order":1,"content":{"title":"Get Contact with `FULL` Fieldset (default)","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: '","response":"{\n \"contact\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:22:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"picture\": {\n \"id\": \"WixMedia image ID\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\"\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"contacts.contacted-me\",\n \"custom.my-label\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"emailSubscriptions.subscriptionStatus\": \"SUBSCRIBED\",\n \"emailSubscriptions.deliverabilityStatus\": \"ACTIVE\",\n \"emailSubscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 2323,\n \"ecom.totalSpentCurrency\": \"USD\",\n \"ecom.lastPurchaseDate\": \"2018-10-30T17:22:10.299Z\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n },\n \"responseType\" : \"REGULAR\"\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"get","path":"/v4/contacts/{id}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"CONTACT_NOT_FOUND"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Contacts","scopeId":"SCOPE.DC-CONTACTS.READ-CONTACTS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-api","serviceArtifactId":"com.wixpress.contacts.contacts-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.core.api.v4.GetContactRequest","responseMessage":"com.wixpress.contacts.core.api.v4.GetContactResponse"},"legacyExamples":[{"name":"GetContact","serviceName":"ContactsServiceV4","type":"METHOD","order":2,"content":{"title":"Get Contact with Projected Fields","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47?fields=source&fields=updatedDate' \\\n -H 'Authorization: '","response":"{\n \"contact\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\"\n },\n \"responseType\" : \"REGULAR\"\n}"}},{"name":"GetContact","serviceName":"ContactsServiceV4","type":"METHOD","order":3,"content":{"title":"Get Contact","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47?fieldsets=BASIC' \\\n -H 'Authorization: '","response":"{\n \"contact\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n }\n }\n },\n \"responseType\" : \"REGULAR\"\n}"}},{"name":"GetContact","serviceName":"ContactsServiceV4","type":"METHOD","order":1,"content":{"title":"Get Contact with `FULL` Fieldset (default)","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47' \\\n -H 'Authorization: '","response":"{\n \"contact\": {\n \"id\": \"8046df3c-7575-4098-a5ab-c91ad8f33c47\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"IMPORT\"\n },\n \"createdDate\": \"2019-10-30T17:22:10.299Z\",\n \"updatedDate\": \"2019-10-30T17:22:10.299Z\",\n \"lastActivity\": {\n \"activityDate\": \"2019-10-30T17:22:10.299Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"email@example.com\",\n \"phone\": \"097495550\"\n },\n \"picture\": {\n \"id\": \"WixMedia image ID\",\n \"url\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/\",\n \"height\": 50,\n \"width\": 50\n },\n \"info\": {\n \"name\": {\n \"first\": \"Some\",\n \"last\": \"One\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"d8f0d88c-af92-4237-833f-56aaaa2b5168\",\n \"tag\": \"MAIN\",\n \"email\": \"email@example.com\",\n \"primary\": true\n },\n {\n \"id\": \"5b430771-e6f1-4bea-9eb5-ad7472270605\",\n \"tag\": \"MAIN\",\n \"email\": \"email2@example.com\"\n }\n ]\n },\n \"phones\": {\n \"items\": [\n {\n \"id\": \"e5214c79-af80-4eff-87f2-408b0be4e710\",\n \"tag\": \"HOME\",\n \"countryCode\": \"IL\",\n \"phone\": \"097495550\",\n \"e164Phone\": \"+97297495550\",\n \"primary\": true\n },\n {\n \"id\": \"59323148-ecf2-4bbe-a7eb-c1b01f43845e \",\n \"tag\": \"MOBILE\",\n \"countryCode\": \"UA\",\n \"phone\": \"0443955571\",\n \"e164Phone\": \"+380443955571\"\n }\n ]\n },\n \"addresses\": {\n \"items\": [\n {\n \"id\": \"3f8bba59-150f-4ee7-9c58-632cbdae222c\",\n \"tag\": \"HOME\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"addressLine\": \"1772 Fantages Way\",\n \"addressLine2\": \"Apt 17\"\n }\n },\n {\n \"id\": \"be0b1932-e081-46b0-8dfa-a9f2409fa3a8\",\n \"tag\": \"WORK\",\n \"address\": {\n \"country\": \"US\",\n \"subdivision\": \"US-ME\",\n \"city\": \"Richmond\",\n \"postalCode\": \"04357\",\n \"streetAddress\": {\n \"number\": \"5\",\n \"name\": \"Wingate\"\n },\n \"addressLine2\": \"the code to the building is: *1234\"\n }\n }\n ]\n },\n \"company\": \"Wix\",\n \"jobTitle\": \"Developer\",\n \"birthdate\": \"1980-12-01\",\n \"locale\": \"en-us\",\n \"labelKeys\": {\n \"items\": [\n \"contacts.contacted-me\",\n \"custom.my-label\"\n ]\n },\n \"extendedFields\": {\n \"items\": {\n \"custom.color\": \"Blue\",\n \"custom.number\": 12,\n \"custom.date\": \"2020-01-01\",\n \"custom.url\": \"http://domain.com\",\n \"members.membershipStatus\": \"APPROVED\",\n \"emailSubscriptions.subscriptionStatus\": \"SUBSCRIBED\",\n \"emailSubscriptions.deliverabilityStatus\": \"ACTIVE\",\n \"emailSubscriptions.effectiveEmail\": \"email@test.rocks\",\n \"ecom.numOfPurchases\": 1,\n \"ecom.totalSpentAmount\": 2323,\n \"ecom.totalSpentCurrency\": \"USD\",\n \"ecom.lastPurchaseDate\": \"2018-10-30T17:22:10.299Z\"\n }\n },\n \"locations\": {\n \"items\": [\n \"d009f926-3273-11eb-adc1-0242ac120002\",\n \"cf2ca920-6ac7-451f-a19b-d0382ab3892f\",\n \"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643\"\n ]\n }\n }\n },\n \"responseType\" : \"REGULAR\"\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Get Contact","slugifiedName":"get-contact"}}],"webhooks":[{"summary":"Contact Created","title":"Contact Created","description":"Triggered when a contact is created.","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Read Contacts","scopeId":"SCOPE.DC-CONTACTS.READ-CONTACTS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"eventType":"wix.contacts.v4.contact_created","legacyExamples":[{"name":"ContactCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"52269077-05f2-4b59-ba4f-36ef8c4c1e11\",\n \"entityFqdn\": \"wix.contacts.v4.contact\",\n \"slug\": \"created\",\n \"entityId\": \"4b0133d5-7903-4411-bcc0-1817d1394028\",\n \"createdEvent\": {\n \"entity\": {\n \"id\": \"4b0133d5-7903-4411-bcc0-1817d1394028\",\n \"source\": {\n \"sourceType\": \"WIX_APP\",\n \"appId\": \"74bff718-5977-47f2-9e5f-a9fd0047fd1f\"\n },\n \"createdDate\": \"2020-10-18T13:40:57.803Z\",\n \"updatedDate\": \"2020-10-18T13:40:57.870Z\",\n \"lastActivity\": {\n \"activityDate\": \"2020-10-18T13:40:57.803Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": { \"email\": \"johndoe@example.com\" },\n \"info\": {\n \"name\": { \"first\": \"John\", \"last\": \"Doe\" },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"95606596-4006-4945-811d-61ba1fca629d\",\n \"email\": \"johndoe@example.com\",\n \"primary\": true\n }\n ]\n },\n \"company\": \"Example\",\n \"jobTitle\": \"manager\",\n \"extendedFields\": {\n \"items\": {\n \"emailSubscriptions.effectiveEmail\": \"johndoe@example.com\",\n \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n \"contacts.displayByFirstName\": \"John Doe\",\n \"contacts.displayByLastName\": \"Doe John\"\n }\n }\n },\n \"primaryEmail\": {\n \"email\": \"johndoe@example.com\",\n \"subscriptionStatus\": \"NOT_SET\",\n \"deliverabilityStatus\": \"NOT_SET\"\n }\n }\n },\n \"eventTime\": \"2020-10-18T13:40:58.304800Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/crm.git","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","contentLink":{"displayName":"Contact Created","slugifiedName":"contact-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Contact Updated","title":"Contact Updated","description":"Triggered when a contact is updated.","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Read Contacts","scopeId":"SCOPE.DC-CONTACTS.READ-CONTACTS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"eventType":"wix.contacts.v4.contact_updated","legacyExamples":[{"name":"ContactUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"30b49365-4af7-47c0-bde1-6bcb7e4be0f8\",\n \"entityFqdn\": \"wix.contacts.v4.contact\",\n \"slug\": \"updated\",\n \"entityId\": \"4b0133d5-7903-4411-bcc0-1817d1394028\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"id\": \"4b0133d5-7903-4411-bcc0-1817d1394028\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"WIX_APP\",\n \"appId\": \"74bff718-5977-47f2-9e5f-a9fd0047fd1f\"\n },\n \"createdDate\": \"2020-10-18T13:40:57.803Z\",\n \"updatedDate\": \"2020-10-18T13:42:11.254Z\",\n \"lastActivity\": {\n \"activityDate\": \"2020-10-18T13:40:57.803Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": {\n \"email\": \"johndoe@example.com\"\n },\n \"info\": {\n \"name\": {\n \"first\": \"John\",\n \"last\": \"Doe\"\n },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"95606596-4006-4945-811d-61ba1fca629d\",\n \"email\": \"johndoe@example.com\",\n \"primary\": true\n }\n ]\n },\n \"company\": \"Example\",\n \"jobTitle\": \"Clerk\",\n \"extendedFields\": {\n \"items\": {\n \"emailSubscriptions.effectiveEmail\": \"johndoe@example.com\",\n \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n \"contacts.displayByFirstName\": \"John Doe\",\n \"contacts.displayByLastName\": \"Doe John\"\n }\n }\n },\n \"primaryEmail\": {\n \"email\": \"johndoe@example.com\",\n \"subscriptionStatus\": \"NOT_SET\",\n \"deliverabilityStatus\": \"NOT_SET\"\n }\n }\n },\n \"eventTime\": \"2020-10-18T13:42:11.943838Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/crm.git","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","contentLink":{"displayName":"Contact Updated","slugifiedName":"contact-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Contact Merged","title":"Contact Merged","description":"Triggered when one or more source contacts are merged into a target contact.\n\nMerging contacts triggers these webhooks:\n\n- [Contact Merged](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-merged-webhook) is triggered.\n- [Contact Updated](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-updated-webhook) is triggered for the target contact. `originatedFrom` is set to `merge`.\n- [Contact Deleted](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-deleted-webhook) is triggered for each source contact. `originatedFrom` is set to `merge`.\n\nIf your app handles the originating merge event,\nit can ignore update and delete events where `originatedFrom` is set to `merge`.\nWhen Contact Updated and Contact Deleted are not triggered from a merge,\n`originatedFrom` is omitted from their payloads.","permissions":["CONTACTS.VIEW"],"payload":{"schemaName":"com.wixpress.contacts.core.api.v4.events.ContactMerged"},"exposure":"PUBLIC","maturity":"GA","slug":"merged","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Read Contacts","scopeId":"SCOPE.DC-CONTACTS.READ-CONTACTS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"eventType":"wix.contacts.v4.contact_merged","legacyExamples":[{"name":"ContactMerged","eventType":"ACTION","type":"DOMAIN_EVENT","content":"{\n \"id\": \"200a394d-4646-482c-b328-23e94563c90c\",\n \"entityFqdn\": \"wix.contacts.v4.contact\",\n \"slug\": \"merged\",\n \"entityId\": \"39d1aab2-2eda-4dd7-95fb-263ccf0e9bb4\",\n \"actionEvent\": {\n \"body\": {\n \"targetContactId\": \"39d1aab2-2eda-4dd7-95fb-263ccf0e9bb4\",\n \"sourceContactIds\": [\"8e2070c3-10dd-40eb-bf81-ab01b4e41e28\"],\n \"targetContact\": {\n \"id\": \"39d1aab2-2eda-4dd7-95fb-263ccf0e9bb4\",\n \"revision\": 1,\n \"source\": {\n \"sourceType\": \"WIX_APP\",\n \"appId\": \"74bff718-5977-47f2-9e5f-a9fd0047fd1f\"\n },\n \"createdDate\": \"2020-10-18T13:40:57.803Z\",\n \"updatedDate\": \"2020-10-18T13:42:11.254Z\",\n \"lastActivity\": {\n \"activityDate\": \"2020-10-18T13:40:57.803Z\",\n \"activityType\": \"CONTACT_CREATED\"\n },\n \"primaryInfo\": { \"email\": \"johndoe@example.com\" },\n \"info\": {\n \"name\": { \"first\": \"John\", \"last\": \"Doe\" },\n \"emails\": {\n \"items\": [\n {\n \"id\": \"95606596-4006-4945-811d-61ba1fca629d\",\n \"email\": \"johndoe@example.com\",\n \"primary\": true\n }\n ]\n },\n \"company\": \"Example\",\n \"jobTitle\": \"Clerk\",\n \"extendedFields\": {\n \"items\": {\n \"emailSubscriptions.effectiveEmail\": \"johndoe@example.com\",\n \"emailSubscriptions.subscriptionStatus\": \"NOT_SET\",\n \"contacts.displayByFirstName\": \"John Doe\",\n \"contacts.displayByLastName\": \"Doe John\"\n }\n }\n },\n \"primaryEmail\": {\n \"email\": \"johndoe@example.com\",\n \"subscriptionStatus\": \"NOT_SET\",\n \"deliverabilityStatus\": \"NOT_SET\"\n }\n }\n }\n },\n \"eventTime\": \"2020-10-20T07:22:04.564864Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/crm.git","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.events.ContactMerged","contentLink":{"displayName":"Contact Merged","slugifiedName":"contact-merged"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]},{"summary":"Contact Deleted","title":"Contact Deleted","description":"Triggered when a contact is deleted.\n\nIf a contact is deleted as part of a merge,\nthe `originatedFrom` property is sent as `merge`.\nOtherwise, `originatedFrom` is omitted.","permissions":["CONTACTS.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.contacts.v4.contact","serviceName":"com.wixpress.contacts.core.api.v4.ContactsServiceV4","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Read Contacts","scopeId":"SCOPE.DC-CONTACTS.READ-CONTACTS"},{"name":"Read Members and Contacts - all read permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.READ-MEMBERS-CONTACTS"},{"name":"Manage Contacts","scopeId":"SCOPE.DC-CONTACTS.MANAGE-CONTACTS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"eventType":"wix.contacts.v4.contact_deleted","legacyExamples":[{"name":"ContactDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"1d186ed0-e111-4405-accd-9bc5eaa9173b\",\n \"entityFqdn\": \"wix.contacts.v4.contact\",\n \"slug\": \"deleted\",\n \"entityId\": \"4b0133d5-7903-4411-bcc0-1817d1394028\",\n \"deletedEvent\": {},\n \"eventTime\": \"2020-10-18T13:42:41.068589Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/crm.git","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","contentLink":{"displayName":"Contact Deleted","slugifiedName":"contact-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Sort, Filter, and Search","slugifyName":"sort-filter-and-search","content":"\n# Contacts: Supported Filters, Sorting, and Search\n\nThis article covers field support for filtering, sorting, and searching\nin the Contacts API,\nincluding for extended fields.\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\n| Field | Supported Filters | Sortable | Searchable |\n|-------------------------------------|-----------------------------------------------|----------|------------|\n| `id` | `$eq`, `$ne`, `$in`, `$exists` | | |\n| `createdDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable | |\n| `updatedDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | | |\n| `lastActivity.activityDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable | |\n| `primaryInfo.email` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | Sortable | |\n| `primaryInfo.phone` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | | |\n| `info.name.first` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | Sortable | Searchable |\n| `info.name.last` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | Sortable | Searchable |\n| `info.emails.email` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | | Searchable |\n| `info.phones.phone` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | | Searchable |\n| `info.phones.e164Phone` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | | Searchable |\n| `info.addresses.street` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | | |\n| `info.addresses.city` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | | |\n| `info.addresses.subdivision` | `$eq`, `$ne`, `$in`, `$exists` | | |\n| `info.addresses.country` | `$eq`, `$ne`, `$in`, `$exists` | | |\n| `info.company` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | Sortable | |\n| `info.jobTitle` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | Sortable | |\n| `info.birthdate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable | |\n| `info.locale` | `$eq`, `$ne`, `$in`, `$exists` | | |\n| `info.labelKeys` | `$hasSome`, `$hasAll` | | |\n| `info.locations` | `$hasSome`, `$hasAll` | | |\n\n## Extended Fields: Supported filters, sorting, and search\n\nThe table below shows field support for filters, sorting,\nand free-text searching\nfor the Wix-defined extended fields (also known as system 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 `emailSubscriptions.effectiveEmail` extended field,\n> use this flattened field name:\n> `\"info.extendedFields.emailSubscriptions.effectiveEmail\"`.\n\n| Field | Supported Filters | Sortable | Searchable |\n| ----------------------------------------- | ------------------------- | -------- | ---------- |\n| `invoices.vatId` | | | |\n| `members.membershipStatus` | `$eq`,`$ne`,`$in`, `$nin` | | |\n| `emailSubscriptions.deliverabilityStatus` | `$eq`,`$ne`,`$in`, `$nin` | | |\n| `emailSubscriptions.subscriptionStatus` | `$eq`,`$ne`,`$in`, `$nin` | | |\n| `emailSubscriptions.effectiveEmail` | `$exists` | Sortable | |\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_.\nSite contributors can add, remove, and change custom field names\nfrom the\n[Contact List](fallback::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 their site's Dashboard.\n\nThe table below shows field support for filters, sorting,\nand free-text searching\nfor 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.newCustomer` extended field,\n> use this flattened field name:\n> `\"info.extendedFields.custom.newCustomer\"`.\n\n| Data Type/Format | Supported Filters | Sortable |\n| ---------------------------------- | ------------------------------------------ | -------- |\n| String | `$eq`, `$ne`, `$in`, `$startsWith` | Sortable |\n| Number | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| Date string in `YYYY-MM-DD` format | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Contacts](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::874fc7dd-ac32-4d57-8b43-3166eff8f210slug::query-contacts*fallback::https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts)\n","sourceRepo":"git@github.com:wix-private/crm.git","path":"docs/sort-and-filter.md"},{"displayName":"Last Activity Types","slugifyName":"last-activity-types","content":"# Last Activity Types\n\nWhen a contact interacts with a 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| `NEWSLETTER_SUBSCRIPTION_SUBSCRIBE` | Subscribed to a site newsletter. |\n| `NEWSLETTER_SUBSCRIPTION_PENDING` | Subscription status to site newsletters is pending confirmation. |\n| `NEWSLETTER_SUBSCRIPTION_NOT_SET` | Subscription status to site newsletters is not set. |\n\n","sourceRepo":"git@github.com:wix-private/crm.git","path":"docs/last-activity.md"}],"components":{"schemas":{"com.wixpress.contacts.core.api.v4.Contact":{"type":"object","properties":{"id":{"description":"Contact ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the contact is updated.\nTo prevent conflicting changes,\nthe existing `revision` must be used when updating a contact.","readOnly":true,"title":"revision","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"source":{"description":"Details about the contact's source.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactSource","summary":"source","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the contact was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the contact was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lastActivity":{"description":"Details about the contact's last action in the site.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactActivity","summary":"lastActivity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"primaryInfo":{"description":"Contact's primary phone and email.","readOnly":true,"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.PrimaryContactInfo","summary":"primaryInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"info":{"description":"Contact's details.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactInfo","summary":"info","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Contact","description":""},"com.wixpress.contacts.core.api.v4.ContactSource":{"type":"object","properties":{"sourceType":{"description":"Source type.","readOnly":true,"title":"sourceType","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactSource.ContactSourceType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"App ID, if the contact was created by an app.","format":"GUID","readOnly":true,"title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactSource","description":""},"com.wixpress.contacts.core.api.v4.ContactSource.ContactSourceType":{"type":"string","description":"","title":"ContactSourceType","enum":["OTHER","ADMIN","WIX_APP","IMPORT","THIRD_PARTY","WIX_BOOKINGS","WIX_CHAT","WIX_EMAIL_MARKETING","WIX_EVENTS","WIX_FORMS","WIX_GROUPS","WIX_HOTELS","WIX_MARKET_PLACE","WIX_MUSIC","WIX_RESTAURANTS","WIX_SITE_MEMBERS","WIX_STORES","WIX_CODE","HOPP"]},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"com.wixpress.contacts.core.api.v4.ContactActivity":{"type":"object","properties":{"activityDate":{"description":"Date and time of the last action.","title":"activityDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activityType":{"description":"Contact's last action in the site.\n\nFor descriptions of each value, see\n[Last Activity Types](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/last-activity-types).","title":"activityType","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactActivity.ContactActivityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactActivity","description":""},"com.wixpress.contacts.core.api.v4.ContactActivity.ContactActivityType":{"type":"string","description":"","title":"ContactActivityType","enum":["GENERAL","CONTACT_CREATED","MEMBER_LOGIN","MEMBER_REGISTER","MEMBER_STATUS_CHANGED","FORM_SUBMITTED","INBOX_FORM_SUBMITTED","INBOX_PAYMENT_REQUEST_PAID","INBOX_MESSAGE_TO_CUSTOMER","INBOX_MESSAGE_FROM_CUSTOMER","NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED","NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE","ECOM_PURCHASE","ECOM_CART_ABANDON","ECOM_CHECKOUT_BUYER","BOOKINGS_APPOINTMENT","HOTELS_RESERVATION","HOTELS_PURCHASE","HOTELS_CONFIRMATION","HOTELS_CANCEL","VIDEO_PURCHASE","VIDEO_RENT","CASHIER_BUTTON_PURCHASE","ARENA_NEW_LEAD","EVENTS_RSVP","INVOICE_PAY","INVOICE_OVERDUE","PRICE_QUOTE_ACCEPT","PRICE_QUOTE_EXPIRE","RESTAURANTS_ORDER","RESTAURANTS_RESERVATION","SHOUTOUT_OPEN","SHOUTOUT_CLICK","CONTACT_MERGED","NEWSLETTER_SUBSCRIPTION_SUBSCRIBE","NEWSLETTER_SUBSCRIPTION_PENDING","NEWSLETTER_SUBSCRIPTION_NOT_SET","PHONE_SUBSCRIPTION_SUBSCRIBE","PHONE_SUBSCRIPTION_PENDING","PHONE_SUBSCRIPTION_NOT_SET","PHONE_SUBSCRIPTION_UNSUBSCRIBE"]},"com.wixpress.contacts.core.api.v4.ActivityIcon":{"type":"object","properties":{"name":{"description":"Icon name","maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Icon url","format":"WEB_URL","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActivityIcon","description":""},"com.wixpress.contacts.core.api.v4.PrimaryContactInfo":{"type":"object","properties":{"email":{"description":"Primary email address.\n\nThis property reflects the email address in `info.emails`\nwhere `primary` is `true`.","format":"EMAIL","readOnly":true,"title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"Primary phone number.\n\nThis property reflects the phone number in `info.phones`\nwhere `primary` is `true`.","readOnly":true,"title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PrimaryContactInfo","description":""},"com.wixpress.contacts.core.api.v4.upstream.wix.common.Image":{"type":"object","properties":{"id":{"description":"WixMedia image ID.\nThis property is written by Wix when an image is uploaded to the Wix Media Manager.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Image source: Either a Media Manager URL or external URL.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Height of the original image.","title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Width of the original image.","title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image alt text. Optional.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"urlExpirationDate":{"description":"Image URL expiration date (when relevant). Optional","readOnly":true,"title":"urlExpirationDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","description":""},"com.wixpress.contacts.core.api.v4.ContactInfo":{"type":"object","properties":{"name":{"description":"Contact's first and last name.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactName","summary":"name","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emails":{"description":"Contact's email addresses.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactEmailsWrapper","summary":"emails","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phones":{"description":"Contact's phone numbers.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactPhonesWrapper","summary":"phones","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addresses":{"description":"Contact's street addresses.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactAddressesWrapper","summary":"addresses","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"company":{"description":"Contact's company name.","maxLength":1000,"title":"company","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"jobTitle":{"description":"Contact's job title.\nCorresponds to the **Position** field in the Dashboard.","maxLength":1000,"title":"jobTitle","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"birthdate":{"description":"Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`.","format":"LOCAL_DATE","title":"birthdate","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"locale":{"description":"Locale in\n[IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nTypically, this is a lowercase 2-letter language code,\nfollowed by a hyphen, followed by an uppercase 2-letter country code.\nFor example, `en-US` for U.S. English, and `de-DE` for Germany German.","format":"LANGUAGE_TAG","title":"locale","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"labelKeys":{"description":"List of contact's labels.\nLabels are used to organize contacts.\nWhen setting the `labelKeys` property,\nonly labels that already exist in the site's Contacts List can be used.\nLabels can be added and removed using\n[Label Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/label-contact) and\n[Unlabel Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/unlabel-contact),\nrespectively.\n\nTo view or manage site labels, use the\n[Labels API](https://dev.wix.com/api/rest/contacts/labels).","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.LabelsWrapper","summary":"labelKeys","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"extendedFields":{"description":"Additional custom fields.\nThis includes fields managed by Wix, by 3rd-party apps, and by the site.\n\nEmpty fields are not returned.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ExtendedFieldsWrapper","summary":"extendedFields","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"picture":{"description":"Contact's profile picture.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactPicture","summary":"picture","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactInfo","description":""},"com.wixpress.contacts.core.api.v4.ContactName":{"type":"object","properties":{"first":{"description":"Contact's first name.","maxLength":1000,"title":"first","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"last":{"description":"Contact's last name.","maxLength":1000,"title":"last","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactName","description":""},"com.wixpress.contacts.core.api.v4.ContactEmailsWrapper":{"type":"object","properties":{"items":{"description":"List of up to 50 email addresses.","maxItems":50,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactEmail"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactEmailsWrapper","description":""},"com.wixpress.contacts.core.api.v4.ContactEmail":{"type":"object","properties":{"id":{"description":"Email ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tag":{"description":"Email type.\n\n`UNTAGGED` is shown as \"Other\" in the Contact List.","title":"tag","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactEmail.EmailTag","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"email":{"description":"Email address.","minLength":1,"maxLength":320,"title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"primary":{"description":"Indicates whether this is the contact's primary email address.\nWhen changing `primary` to `true` for an email,\nthe contact's other emails become `false`.\nIt also affects the subscription status to marketing emails that are decided based on the primary email.","title":"primary","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactEmail","description":""},"com.wixpress.contacts.core.api.v4.ContactEmail.EmailTag":{"type":"string","description":"","title":"EmailTag","enum":["UNTAGGED","MAIN","HOME","WORK"]},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"com.wixpress.contacts.core.api.v4.ContactPhonesWrapper":{"type":"object","properties":{"items":{"description":"List of up to 50 phone numbers.","maxItems":50,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactPhone"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactPhonesWrapper","description":""},"com.wixpress.contacts.core.api.v4.ContactPhone":{"type":"object","properties":{"id":{"description":"Phone ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tag":{"description":"Phone type.\n\n`UNTAGGED` is shown as \"Other\" in the Contact List.","title":"tag","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactPhone.PhoneTag","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"countryCode":{"description":"[ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.","format":"COUNTRY","title":"countryCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"Phone number.","minLength":1,"maxLength":50,"title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"e164Phone":{"description":"[ITU E.164-formatted](https://www.itu.int/rec/T-REC-E.164/)\nphone number.\nAutomatically generated using `phone` and `countryCode`, pending both values are valid.","readOnly":true,"title":"e164Phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"primary":{"description":"Whether this is the contact's primary phone number.\nWhen changing `primary` to `true` for a phone,\nthe contact's `primary` field for other phones becomes `false`.\nIt also affects the subscription status to SMS messages that are decided based on the primary phone.","title":"primary","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactPhone","description":""},"com.wixpress.contacts.core.api.v4.ContactPhone.PhoneTag":{"type":"string","description":"","title":"PhoneTag","enum":["UNTAGGED","MAIN","HOME","MOBILE","WORK","FAX"]},"com.wixpress.contacts.core.api.v4.ContactAddressesWrapper":{"type":"object","properties":{"items":{"description":"List of up to 50 addresses.","maxItems":50,"title":"items","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactAddress"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactAddressesWrapper","description":""},"com.wixpress.contacts.core.api.v4.ContactAddress":{"type":"object","properties":{"id":{"description":"Street address ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tag":{"description":"Address type.\n`UNTAGGED` is shown as \"Other\" in the Contact List.","title":"tag","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactAddress.AddressTag","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"address":{"description":"Street address.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Address","summary":"address","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactAddress","description":""},"com.wixpress.contacts.core.api.v4.ContactAddress.AddressTag":{"type":"string","description":"","title":"AddressTag","enum":["UNTAGGED","HOME","WORK","BILLING","SHIPPING"]},"com.wixpress.contacts.core.api.v4.upstream.wix.common.Address":{"type":"object","properties":{"country":{"description":"2-letter country code in an\n[ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.","format":"COUNTRY","title":"country","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subdivision":{"description":"Code for a subdivision (such as state, prefecture, or province) in an\n[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.","maxLength":100,"title":"subdivision","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"city":{"description":"City name.","maxLength":1000,"title":"city","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"postalCode":{"description":"Postal or zip code.","maxLength":100,"title":"postalCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addressLine2":{"description":"Free text providing more detailed address information,\nsuch as apartment, suite, or floor.","maxLength":1000,"title":"addressLine2","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Address","description":"Physical address","oneOf":[{"description":"","summary":"street","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Address.street"}]},"com.wixpress.contacts.core.api.v4.upstream.wix.common.Address.street":{"type":"object","title":"street","properties":{"streetAddress":{"description":"Street address object, with number and name in separate fields.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.StreetAddress","summary":"streetAddress","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"addressLine":{"description":"Main address line, usually street and number, as free text.","maxLength":1000,"title":"addressLine","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.contacts.core.api.v4.upstream.wix.common.StreetAddress":{"type":"object","properties":{"number":{"description":"Street number.","maxLength":100,"title":"number","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Street name.","maxLength":1000,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StreetAddress","description":""},"com.wixpress.contacts.core.api.v4.upstream.wix.common.AddressLocation":{"type":"object","properties":{"latitude":{"description":"Address's latitude.","title":"latitude","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"longitude":{"description":"Address's longitude.","title":"longitude","type":"number","format":"double","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddressLocation","description":""},"google.protobuf.DoubleValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DoubleValue","description":""},"com.wixpress.contacts.core.api.v4.upstream.wix.common.Subdivision":{"type":"object","properties":{"code":{"description":"subdivision short code","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Full subdivision name.","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Subdivision","description":""},"com.wixpress.contacts.core.api.v4.upstream.wix.common.Subdivision.SubdivisionType":{"type":"string","description":"","title":"SubdivisionType","enum":["UNKNOWN_SUBDIVISION_TYPE","ADMINISTRATIVE_AREA_LEVEL_1","ADMINISTRATIVE_AREA_LEVEL_2","ADMINISTRATIVE_AREA_LEVEL_3","ADMINISTRATIVE_AREA_LEVEL_4","ADMINISTRATIVE_AREA_LEVEL_5","COUNTRY"]},"com.wixpress.contacts.core.api.v4.AssigneesWrapper":{"type":"object","properties":{"items":{"description":"List of site contributor user IDs.","format":"GUID","maxItems":50,"title":"items","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AssigneesWrapper","description":""},"com.wixpress.contacts.core.api.v4.LabelsWrapper":{"type":"object","properties":{"items":{"description":"List of contact label keys.\n[Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)\nhelp categorize contacts.\n\nLabel keys must exist to be added to the contact.\nContact labels can be created or retrieved with\n[Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)\nor\n[List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)","maxItems":2000,"title":"items","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LabelsWrapper","description":""},"com.wixpress.contacts.core.api.v4.ExtendedFieldsWrapper":{"type":"object","properties":{"items":{"description":"Contact's extended fields,\nwhere each key is the field key,\nand each value is the field's value for the contact.\n\nTo view and manage extended fields, use the\n[Extended Fields API](https://dev.wix.com/api/rest/contacts/extended-fields).","title":"items","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExtendedFieldsWrapper","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"com.wixpress.contacts.core.api.v4.LocationsWrapper":{"type":"object","properties":{"items":{"description":"List of location ids.","format":"GUID","maxItems":50,"title":"items","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LocationsWrapper","description":""},"com.wixpress.contacts.core.api.v4.ContactPicture":{"type":"object","properties":{"image":{"description":"Image.\nThis can contain an image URL or a Wix Media image ID.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Image","summary":"image","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactPicture","description":"TEST contact picture description"},"com.wixpress.contacts.core.api.v4.ContactPicture.ImageProvider":{"type":"string","description":"","title":"ImageProvider","enum":["UNKNOWN","EXTERNAL","WIX_MEDIA"]},"com.wixpress.contacts.core.api.v4.SegmentsWrapper":{"type":"object","properties":{"items":{"description":"List of Contact segment IDs","maxItems":60,"format":"GUID","title":"items","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SegmentsWrapper","description":""},"com.wixpress.contacts.core.api.v4.PrimaryEmail":{"type":"object","properties":{"email":{"description":"Primary email address.\n\nThis property reflects the email address in `info.emails`\nwhere `primary` is `true`.","format":"EMAIL","readOnly":true,"title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subscriptionStatus":{"description":"Indicates the recipient's opt-in or opt-out status for marketing emails.\n\n- `NOT_SET`: No status specified. Default.\n- `PENDING`: Subscription confirmation was requested,\nbut recipient hasn't confirmed yet.\n- `SUBSCRIBED`: Recipient has opted in to marketing emails.\n- `UNSUBSCRIBED`: Recipient has opted out of marketing emails.","readOnly":true,"title":"subscriptionStatus","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.SubscriptionStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deliverabilityStatus":{"description":"Indicates last reported status of sent emails.\n\n- `NOT_SET`: No status reported. Default.\n- `VALID`: Emails are being successfully delivered.\n- `BOUNCED`: The last email to the recipient bounced or was rejected.\n- `SPAM_COMPLAINT`: Recipient registered a spam complaint\nwith their email provider.\n- `INACTIVE`: Multiple emails have been delivered without any kind of engagement from the recipient.","readOnly":true,"title":"deliverabilityStatus","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.PrimaryEmail.EmailDeliverabilityStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PrimaryEmail","description":""},"com.wixpress.contacts.core.api.v4.SubscriptionStatus":{"type":"string","description":"","title":"SubscriptionStatus","enum":["NO_SUBSCRIPTION_STATUS","NOT_SET","PENDING","SUBSCRIBED","UNSUBSCRIBED"]},"com.wixpress.contacts.core.api.v4.PrimaryEmail.EmailDeliverabilityStatus":{"type":"string","description":"","title":"EmailDeliverabilityStatus","enum":["UNKNOWN_EMAIL_DELIVERABILITY_STATUS","NOT_SET","VALID","BOUNCED","SPAM_COMPLAINT","INACTIVE"]},"com.wixpress.contacts.core.api.v4.PrimaryPhone":{"type":"object","properties":{"countryCode":{"description":"[ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the primary phone.","format":"COUNTRY","title":"countryCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"e164Phone":{"description":"[ITU E.164-formatted](https://www.itu.int/rec/T-REC-E.164/)\nphone number.\nAutomatically generated using `phone` and `countryCode`,\nas long as both of those values are valid.","readOnly":true,"title":"e164Phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"formattedPhone":{"description":"Formatted phone. Automatically generated using phone and countryCode.","readOnly":true,"title":"formattedPhone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subscriptionStatus":{"description":"Indicates the recipient's opt-in or opt-out status for SMS messages.\n\n- `NO_SUBSCRIPTION_STATUS`: No status exists. This is the status when the phone is not a valid E164 phone.\n- `NOT_SET`: No status specified. Default when the phone is a valid E164 phone.\n- `PENDING`: Subscription confirmation was requested,\nbut recipient hasn't confirmed yet.\n- `SUBSCRIBED`: Recipient has opted in to SMS messages.\n- `UNSUBSCRIBED`: Recipient has opted out of SMS messages.","readOnly":true,"title":"subscriptionStatus","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.SubscriptionStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"Primary phone number.\n\nThis property reflects the phone number in `info.phones`\nwhere `primary` is `true`.","readOnly":true,"title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PrimaryPhone","description":""},"com.wixpress.contacts.core.api.v4.PrimaryPhone.PhoneDeliverabilityStatus":{"type":"string","description":"","title":"PhoneDeliverabilityStatus","enum":["NO_PHONE_DELIVERABILITY_STATUS","NOT_SET"]},"com.wixpress.contacts.core.api.v4.MemberInfo":{"type":"object","properties":{"memberId":{"description":"Member ID","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"signupDate":{"description":"Signup date","title":"signupDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"email":{"description":"Login email","format":"EMAIL","title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailVerified":{"description":"Indicate whether the email is verified","title":"emailVerified","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailVerificationRequired":{"description":"Indicates whether the member is required to verify their email","title":"emailVerificationRequired","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Member status.\n- `PENDING`: Member created and is waiting for approval by site owner.\n- `ACTIVE`: Member can log in to the site.\n- `OFFLINE`: Member is a [managed writer](https://support.wix.com/en/article/wix-blog-adding-managed-writers-to-your-blog) for the site blog and cannot log in to the site.\n- `BLOCKED': Member is blocked and cannot log in to the site.","title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.MemberInfo.MemberStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"profileInfo":{"description":"Profile info","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ProfileInfo","summary":"profileInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"userInfo":{"description":"User info","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.UserInfo","summary":"userInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sessionInfo":{"description":"Session info","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.SessionInfo","summary":"sessionInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupInfo":{"description":"Group info","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.GroupInfo","summary":"groupInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MemberInfo","description":""},"com.wixpress.contacts.core.api.v4.MemberInfo.MemberStatus":{"type":"string","description":"","title":"MemberStatus","enum":["UNKNOWN_MEMBER_STATUS","PENDING","ACTIVE","DELETED","BLOCKED","OFFLINE"]},"com.wixpress.contacts.core.api.v4.ProfileInfo":{"type":"object","properties":{"nickname":{"description":"Nickname","maxLength":255,"title":"nickname","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"privacyStatus":{"description":"Privacy status","title":"privacyStatus","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ProfileInfo.PrivacyStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reported":{"description":"Indicate whether the member is reported","title":"reported","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"muted":{"description":"Indicate whether the member is muted","title":"muted","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"photo":{"description":"Profile photo","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Image","summary":"photo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProfileInfo","description":""},"com.wixpress.contacts.core.api.v4.ProfileInfo.PrivacyStatus":{"type":"string","description":"","title":"PrivacyStatus","enum":["UNKNOWN_PRIVACY_STATUS","PRIVATE","PUBLIC"]},"com.wixpress.contacts.core.api.v4.UserInfo":{"type":"object","properties":{"userId":{"description":"User ID","format":"GUID","title":"userId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"role":{"description":"The user's role on the website","title":"role","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.UserInfo.Role","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UserInfo","description":""},"com.wixpress.contacts.core.api.v4.UserInfo.Role":{"type":"string","description":"","title":"Role","enum":["UNSPECIFIED_ROLE","OWNER","CONTRIBUTOR"]},"com.wixpress.contacts.core.api.v4.SessionInfo":{"type":"object","properties":{"lastWebLogin":{"description":"Last time the member logged in to the website","title":"lastWebLogin","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lastMobileLogin":{"description":"Last time the member logged in to one of the mobile apps","title":"lastMobileLogin","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mobileAppNames":{"description":"List of mobile apps that the member has ever logged in to","maxItems":50,"maxLength":50,"title":"mobileAppNames","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SessionInfo","description":""},"com.wixpress.contacts.core.api.v4.GroupInfo":{"type":"object","properties":{"groupIds":{"description":"Group IDs","format":"GUID","maxItems":1000,"title":"groupIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GroupInfo","description":""},"com.wixpress.contacts.core.api.v4.events.ContactSubmitted":{"type":"object","properties":{"passThroughData":{"description":"Pass through data, submitted with the contact","title":"passThroughData","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activity":{"description":"Submitted activity","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactActivity","summary":"activity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contact":{"description":"Submitted Contact (after processing)","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactSubmitted","description":""},"com.wixpress.contacts.core.api.v4.events.ContactChanged":{"type":"object","properties":{"previousContact":{"description":"The Contact before the changes","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"previousContact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"currentContact":{"description":"The Contact after the changes","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"currentContact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactChanged","description":""},"com.wixpress.contacts.core.api.v4.events.ContactEmailSubscriptionUpdated":{"type":"object","properties":{"contactId":{"description":"The updated contact ID.","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"The revision of the contact.","title":"revision","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"primaryEmail":{"description":"The primary email of the contact with the updated subscription and deliverability status.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.PrimaryEmail","summary":"primaryEmail","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the contact was updated with the email subscription or deliverability status.","title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactEmailSubscriptionUpdated","description":""},"com.wixpress.contacts.core.api.v4.events.ContactPhoneSubscriptionUpdated":{"type":"object","properties":{"contactId":{"description":"The updated contact ID.","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"The revision of the contact.","title":"revision","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"primaryPhone":{"description":"The primary phone of the contact with the updated subscription status.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.PrimaryPhone","summary":"primaryPhone","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the contact was updated with the SMS subscription status.","title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactPhoneSubscriptionUpdated","description":""},"com.wixpress.contacts.core.api.v4.events.ContactPrimaryInfoUpdated":{"type":"object","properties":{"contactId":{"description":"The updated contact ID.","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"primaryEmailUpdated":{"description":"Indication whether the primary email was updated.","title":"primaryEmailUpdated","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"primaryPhoneUpdated":{"description":"Indication whether primary phone was updated.","title":"primaryPhoneUpdated","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"previousPrimaryEmailSubscriptionStatus":{"description":"previous primary email subscription status","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.events.PrimarySubscriptionStatus","summary":"previousPrimaryEmailSubscriptionStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"previousPrimaryPhoneSubscriptionStatus":{"description":"previous primary phone subscription status","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.events.PrimarySubscriptionStatus","summary":"previousPrimaryPhoneSubscriptionStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactPrimaryInfoUpdated","description":"This message is an internal message used by this app and it is used to trigger\nthe update of the subscription status of the contact asynchronously.\nIt is published after a contact is created/updated/merged."},"com.wixpress.contacts.core.api.v4.events.PrimarySubscriptionStatus":{"type":"object","properties":{"subscriptionStatus":{"description":"subscription status","title":"subscriptionStatus","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.SubscriptionStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PrimarySubscriptionStatus","description":""},"com.wixpress.contacts.core.api.v4.events.LastActivityUpdate":{"type":"object","properties":{"contactId":{"description":"The contact ID.","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activityDate":{"description":"Activity date.","title":"activityDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activityTranslationKey":{"description":"Activity translation key.","maxLength":100,"title":"activityTranslationKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"icon":{"description":"Activity icon.","maxLength":100,"title":"icon","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LastActivityUpdate","description":"This message is an internal message used by this app and it is used to trigger\nthe update of the contact's last activity is done asynchronously."},"com.wixpress.contacts.core.api.v4.CreateContactRequest":{"type":"object","properties":{"info":{"description":"Contact info.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactInfo","summary":"info","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allowDuplicates":{"description":"Controls whether the call will succeed\nif the new contact information contains an email or a phone number already used by another contact.\n\nIf set to `true`,\nthe call will succeed even if an email address or phone number is used by another contact.\nIf set to `false`,\nthe call will fail if the given email address is used by another contact or,\nif the email address is not given and the given phone number is used by another contact.\n\nDefault: `false`","title":"allowDuplicates","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateContactRequest","description":"Contact creation options."},"com.wixpress.contacts.core.api.v4.CreateContactResponse":{"type":"object","properties":{"contact":{"description":"Contact.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateContactResponse","description":"Contact."},"com.wixpress.contacts.core.api.v4.DuplicateContactExists":{"type":"object","properties":{"duplicateContactId":{"description":"","format":"GUID","title":"duplicateContactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"duplicateEmail":{"description":"","format":"EMAIL","title":"duplicateEmail","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"duplicatePhone":{"description":"","format":"PHONE","title":"duplicatePhone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DuplicateContactExists","description":""},"com.wixpress.contacts.core.api.v4.UpdateContactRequest":{"type":"object","properties":{"contactId":{"description":"ID of the contact to update.","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number.\nWhen updating, include the existing `revision`\nto prevent conflicting updates.","title":"revision","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"allowDuplicates":{"description":"Controls whether the call will succeed\nif the new contact information contains an email or a phone number already used by another contact.\n\nIf set to `true`,\nthe call will succeed even if an email address or phone number is used by another contact.\nIf set to `false`,\nthe call will fail if the given email address is used by another contact or,\nif the email address is not given and the given phone number is used by another contact.\n\nDefault: `false`","title":"allowDuplicates","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"info":{"description":"Contact info.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactInfo","summary":"info","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateContactRequest","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"com.wixpress.contacts.core.api.v4.UpdateContactResponse":{"type":"object","properties":{"contact":{"description":"Updated contact.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateContactResponse","description":"Updated contact."},"com.wixpress.contacts.core.api.v4.MergeContactsRequest":{"type":"object","properties":{"targetContactId":{"description":"Target contact ID.","format":"GUID","title":"targetContactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"targetContactRevision":{"description":"Target contact revision number, which increments by 1 each time the contact is updated.\nTo prevent conflicting changes,\nthe target contact's current revision must be passed.","title":"targetContactRevision","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sourceContactIds":{"description":"IDs of up to 5 contacts to merge into the target contact.\nIf merging more than one source contact,\nthe first source is given precedence, then the second, and so on.","minItems":1,"maxItems":5,"title":"sourceContactIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MergeContactsRequest","description":""},"com.wixpress.contacts.core.api.v4.MergeContactsResponse":{"type":"object","properties":{"contact":{"description":"Updated target contact.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MergeContactsResponse","description":""},"com.wixpress.contacts.core.api.v4.events.ContactMerged":{"type":"object","properties":{"targetContactId":{"description":"ID of the contact the source contacts were merged into.","title":"targetContactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sourceContactIds":{"description":"IDs of contacts that were merged into the target contact.","title":"sourceContactIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"targetContact":{"description":"Updated target contact.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"targetContact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactMerged","description":""},"com.wixpress.contacts.core.api.v4.PreviewMergeContactsRequest":{"type":"object","properties":{"targetContactId":{"description":"Target contact ID.","format":"GUID","title":"targetContactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sourceContactIds":{"description":"IDs of up to 5 contacts to merge into the target contact.\nIf merging more than one source contact,\nthe first source is given precedence, then the second, and so on.","minItems":1,"maxItems":5,"title":"sourceContactIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PreviewMergeContactsRequest","description":""},"com.wixpress.contacts.core.api.v4.PreviewMergeContactsResponse":{"type":"object","properties":{"contact":{"description":"Preview of the updated target contact.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PreviewMergeContactsResponse","description":""},"com.wixpress.contacts.core.api.v4.DeleteContactRequest":{"type":"object","properties":{"contactId":{"description":"ID of the contact to delete.","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteContactRequest","description":""},"com.wixpress.contacts.core.api.v4.DeleteContactResponse":{"type":"object","properties":{},"title":"DeleteContactResponse","description":""},"com.wixpress.contacts.core.api.v4.LabelContactRequest":{"type":"object","properties":{"contactId":{"description":"ID of the contact to add labels to.","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"labelKeys":{"description":"List of label keys to add to the contact.\n\nLabel keys must exist to be added to the contact.\nContact labels can be created or retrieved with\n[Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)\nor\n[List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels).","minItems":1,"maxItems":100,"title":"labelKeys","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LabelContactRequest","description":""},"com.wixpress.contacts.core.api.v4.LabelContactResponse":{"type":"object","properties":{"contact":{"description":"Updated contact.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LabelContactResponse","description":"Updated contact."},"com.wixpress.contacts.core.api.v4.UnlabelContactRequest":{"type":"object","properties":{"contactId":{"description":"ID of the contact to remove labels from.","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"labelKeys":{"description":"List of label keys to remove from the contact.","minItems":1,"maxItems":100,"title":"labelKeys","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UnlabelContactRequest","description":""},"com.wixpress.contacts.core.api.v4.UnlabelContactResponse":{"type":"object","properties":{"contact":{"description":"Updated contact.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UnlabelContactResponse","description":"Updated contact."},"com.wixpress.contacts.core.api.v4.LabelAndUnlabelContactRequest":{"type":"object","properties":{"contactId":{"description":"Contact ID.","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"labelKeysToAdd":{"description":"List of label keys to add to the contact.\n\nLabel keys must exist to be added to the contact.\nContact labels can be created or retrieved with\n[Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)\nor\n[List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels).","minItems":1,"maxItems":100,"title":"labelKeysToAdd","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"labelKeysToRemove":{"description":"List of label keys to remove from the contact.","minItems":1,"maxItems":100,"title":"labelKeysToRemove","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LabelAndUnlabelContactRequest","description":""},"com.wixpress.contacts.core.api.v4.LabelAndUnlabelContactResponse":{"type":"object","properties":{"contact":{"description":"Updated contact.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LabelAndUnlabelContactResponse","description":""},"com.wixpress.contacts.core.api.v4.ListContactsRequest":{"type":"object","properties":{"sort":{"description":"[Sort order](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter).","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Sorting","summary":"sort","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paging":{"description":"[Pagination](https://dev.wix.com/api/rest/getting-started/pagination), defaults to offset = 0 and limit = 50 (max limit 1,000).","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"List of projected fields to return.\nIf both `fields` and `fieldsets` are sent in the request,\nthe union of both lists is returned.\n`id` and `revision` are always returned.\n\nSupported properties:\n`source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,\n`info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,\n`info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,\n`info.labelKeys`, `info.locations`, `info.extendedFields`","maxLength":100,"maxItems":100,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactFieldSet"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListContactsRequest","description":""},"com.wixpress.contacts.core.api.v4.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Field to sort by.\n\nSupported properties:\n`createdDate`, `lastActivity.activityDate`, `primaryInfo.email`, `info.name.first`, `info.name.last`, `info.company`,\n`info.jobTitle`, `info.birthdate`","maxLength":100,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.\nUse `ASC` for ascending order or `DESC` for descending order.\n\nDefaults to `ASC`.","title":"order","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"com.wixpress.contacts.core.api.v4.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"com.wixpress.contacts.core.api.v4.upstream.wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to return. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination) for more information.\n\nDefaults to `50`.
\nMaximum: `1000`.","minimum":0,"maximum":1000,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"com.wixpress.contacts.core.api.v4.ContactFieldSet":{"type":"string","description":"","title":"ContactFieldSet","enum":["BASIC","COMMUNICATION_DETAILS","EXTENDED","FULL"]},"com.wixpress.contacts.core.api.v4.ListContactsResponse":{"type":"object","properties":{"contacts":{"description":"List of contacts.","title":"contacts","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.PagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListContactsResponse","description":"List of contacts."},"com.wixpress.contacts.core.api.v4.upstream.wix.common.PagingMetadata":{"type":"object","properties":{"count":{"description":"The number of items returned in this response","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"The offset which was requested","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"The total number of items that match the query","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"A flag that indicates the server failed to calculate 'total' field","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadata","description":""},"com.wixpress.contacts.core.api.v4.QueryContactsRequest":{"type":"object","properties":{"search":{"description":"Plain text search for an exact match.\n\nSupported properties:\n`info.name.first`, `info.name.last`, `info.emails.email`, `info.phones.phone`\n\nMax: 100 characters","maxLength":100,"title":"search","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"query":{"description":"Query options.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.query.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryContactsRequest","description":""},"com.wixpress.contacts.core.api.v4.upstream.wix.query.Query":{"type":"object","properties":{"filter":{"description":"Filter object.\nSee [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)\nfor more information.\n\nFor a detailed list of supported filters, see\n[Supported Filters](https://dev.wix.com/api/rest/contacts/contacts/supported-filters).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sorting options.\nSee [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination)\nfor more information.\n\nMax: 1 sort object","maxItems":1,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paging":{"description":"Pagination options.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"List of projected fields to return.\nIf both `fields` and `fieldsets` are sent in the request,\nthe union of both lists is returned.\n`id` and `revision` are always returned.\n\nSupported properties:\n`source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,\n`info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,\n`info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,\n`info.labelKeys`, `info.locations`, `info.extendedFields`","maxLength":100,"maxItems":100,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"Predefined sets of fields to return.\nIf both `fields` and `fieldsets` are sent in the request,\nthe union of both lists is returned.\n\n- `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.\n- `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.\n- `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.\n- `FULL`: Returns all fields.\n\nDefault: If `fields` is omitted from the request, `FULL`.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactFieldSet"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Query","description":""},"com.wixpress.contacts.core.api.v4.QueryContactsResponse":{"type":"object","properties":{"contacts":{"description":"List of contacts.","title":"contacts","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.PagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryContactsResponse","description":"List of contacts."},"com.wixpress.contacts.core.api.v4.ListFacetsRequest":{"type":"object","properties":{"paging":{"description":"Allow paginating, default: offset = 0 and limit = 1000","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language for localization","format":"LANGUAGE","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListFacetsRequest","description":""},"com.wixpress.contacts.core.api.v4.ListFacetsResponse":{"type":"object","properties":{"facets":{"description":"List of facets.","title":"facets","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactsFacet"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.PagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListFacetsResponse","description":""},"com.wixpress.contacts.core.api.v4.ContactsFacet":{"type":"object","properties":{"facetType":{"description":"Type of facet.","title":"facetType","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactsFacet.ContactsFacetType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespace":{"description":"Scope for facet keys.\nWhen a facet key exists in a namespace,\neach key is unique within that namespace.\n\nCurrently, facets not created by Wix are in the `custom` namespace.","title":"namespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespaceDisplayName":{"description":"Human-readable display name.","title":"namespaceDisplayName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"facetKey":{"description":"Facet key, automatically generated.","title":"facetKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"facetDisplayName":{"description":"Human-readable name. Shown in the Wix UI.","title":"facetDisplayName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"count":{"description":"Number of contacts the facet is applied to.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"queryFilter":{"description":"Filter used for query contacts of this facet","title":"queryFilter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactsFacet","description":""},"com.wixpress.contacts.core.api.v4.ContactsFacet.ContactsFacetType":{"type":"string","description":"","title":"ContactsFacetType","enum":["UNKNOWN","ALL_CONTACTS","NOT_LABELED","LABEL","SUBSCRIPTION_STATUS","MEMBERSHIP_STATUS"]},"com.wixpress.contacts.core.api.v4.QueryFacetsRequest":{"type":"object","properties":{"paging":{"description":"Allow paginating, default: offset = 0 and limit = 1000","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Language for localization","format":"LANGUAGE","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filter":{"description":"Only allowed fields:\n#info.extendedFields.emailSubscriptions.effectiveEmail ($exists)\n#info.extendedFields.emailSubscriptions.subscriptionStatus ($eq, $ne, $in, $nin)\n#info.extendedFields.emailSubscriptions.deliverabilityStatus ($eq, $ne, $in, $nin)","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryFacetsRequest","description":""},"com.wixpress.contacts.core.api.v4.QueryFacetsResponse":{"type":"object","properties":{"facets":{"description":"List of facets.","title":"facets","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactsFacet"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.PagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryFacetsResponse","description":""},"com.wixpress.contacts.core.api.v4.BulkDeleteContactsRequest":{"type":"object","properties":{"filter":{"description":"Filter object.\n\nPossible filters:\n`$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.\n\nFor a detailed list of supported filters, see\nfiltering and sorting for\n[contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),\n[extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),\nand [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).\n\nExample:\n`{ \"filter\": { \"info.name.last\": \"Smith\" } }`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Plain text search for an exact match, up to 100 characters.\n\nSearchable fields:\n\n- `info.name.first`\n- `info.name.last`\n- `info.emails.email`\n- `info.phones.phone`","maxLength":100,"title":"search","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteContactsRequest","description":""},"com.wixpress.contacts.core.api.v4.BulkDeleteContactsResponse":{"type":"object","properties":{"jobId":{"description":"Bulk job ID.\nThe job's status can be retrieved with\n[Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n[List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteContactsResponse","description":""},"com.wixpress.contacts.core.api.v4.BulkUpdateContactsRequest":{"type":"object","properties":{"filter":{"description":"Filter object.\n\nPossible filters:\n`$eq`, `$exists`, `$gt`, `$gte`, `$hasAll`, `$hasSome`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.\n\nFor a detailed list of supported filters, see\nfiltering and sorting for\n[contact properties](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#contact-properties-filtering-sorting-and-searching),\n[extended fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#extended-fields-filtering-sorting-and-searching),\nand [custom fields](https://dev.wix.com/api/rest/contacts/contacts/sorting,-filtering,-and-searching#custom-fields-filtering-sorting-and-searching).\n\nExample:\n`{ \"filter\": { \"info.name.last\": \"Smith\" } }`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Plain text search for an exact match, up to 100 characters.\n\nSearchable fields:\n\n- `info.name.first`\n- `info.name.last`\n- `info.emails.email`\n- `info.phones.phone`","maxLength":100,"title":"search","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"info":{"description":"Contact info.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactInfo","summary":"info","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateContactsRequest","description":""},"com.wixpress.contacts.core.api.v4.BulkUpdateContactsResponse":{"type":"object","properties":{"jobId":{"description":"Bulk job ID.\nThe job's status can be retrieved with\n[Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n[List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpdateContactsResponse","description":""},"com.wixpress.contacts.core.api.v4.BulkLabelAndUnlabelContactsRequest":{"type":"object","properties":{"filter":{"description":"Filter options.\nLabels will be removed from contacts that meet the `filter` and `search` criteria.\n\nSee\n[Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter#contacts_contacts_sort-and-filter_field-support-for-filtering-sorting-and-searching)\nfor a list of supported filters and fields.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Plain text search for an exact match, up to 100 characters.\nLabels will be removed from contacts that meet the `filter` and `search` criteria.\n\nSee\n[Field Support for Filtering, Sorting, and Searching](https://dev.wix.com/api/rest/contacts/contacts/sort-and-filter#contacts_contacts_sort-and-filter_field-support-for-filtering-sorting-and-searching)\nfor a list of searchable fields.","maxLength":100,"title":"search","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"labelKeysToAdd":{"description":"List of label keys to add to the contacts.\n\nLabel keys must exist to be added to the contact.\nContact labels can be created or retrieved with\n[Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)\nor\n[List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)","maxItems":100,"title":"labelKeysToAdd","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"labelKeysToRemove":{"description":"List of label keys to remove from the contacts.","maxItems":100,"title":"labelKeysToRemove","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkLabelAndUnlabelContactsRequest","description":""},"com.wixpress.contacts.core.api.v4.BulkLabelAndUnlabelContactsResponse":{"type":"object","properties":{"jobId":{"description":"Bulk job ID.\nThe job's status can be retrieved with\n[Get Bulk Job](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/get-bulk-job) or\n[List Bulk Jobs](https://dev.wix.com/api/rest/contacts/contacts/bulk-jobs/list-bulk-jobs).","format":"GUID","title":"jobId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkLabelAndUnlabelContactsResponse","description":""},"com.wixpress.contacts.core.api.v4.BulkUpsertContactsRequest":{"type":"object","properties":{"info":{"description":"","minItems":1,"maxItems":100,"title":"info","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactInfo"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnFullEntity":{"description":"","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpsertContactsRequest","description":""},"com.wixpress.contacts.core.api.v4.BulkUpsertContactsResponse":{"type":"object","properties":{"results":{"description":"","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.BulkUpsertContactsResponse.Item"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.BulkUpsertContactsResponse.Metadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkUpsertContactsResponse","description":""},"com.wixpress.contacts.core.api.v4.BulkUpsertContactsResponse.Item.Metadata.Action":{"type":"string","description":"","title":"Action","enum":["UNKNOWN","UPDATED","CREATED"]},"com.wixpress.contacts.core.api.v4.BulkUpsertContactsResponse.Item.Metadata.Error":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"message":{"description":"Error details.","title":"message","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Error","description":""},"com.wixpress.contacts.core.api.v4.BulkUpsertContactsResponse.Item.Metadata":{"type":"object","properties":{"id":{"description":"","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"action":{"description":"","title":"action","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.BulkUpsertContactsResponse.Item.Metadata.Action","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.BulkUpsertContactsResponse.Item.Metadata.Error","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Metadata","description":""},"com.wixpress.contacts.core.api.v4.BulkUpsertContactsResponse.Item":{"type":"object","properties":{"contact":{"description":"","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.BulkUpsertContactsResponse.Item.Metadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Item","description":""},"com.wixpress.contacts.core.api.v4.BulkUpsertContactsResponse.Metadata":{"type":"object","properties":{"totalSuccess":{"description":"","title":"totalSuccess","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailure":{"description":"","title":"totalFailure","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalCreated":{"description":"","title":"totalCreated","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalUpdated":{"description":"","title":"totalUpdated","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Metadata","description":""},"com.wixpress.contacts.core.api.v4.UpsertContactRequest":{"type":"object","properties":{"info":{"description":"","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactInfo","summary":"info","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpsertContactRequest","description":""},"com.wixpress.contacts.core.api.v4.UpsertContactResponse":{"type":"object","properties":{"contact":{"description":"Upserted contact.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"action":{"description":"","title":"action","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.UpsertContactResponse.Action","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpsertContactResponse","description":""},"com.wixpress.contacts.core.api.v4.UpsertContactResponse.Action":{"type":"string","description":"","title":"Action","enum":["UNKNOWN","UPDATED","CREATED"]},"com.wixpress.contacts.core.api.v4.GeneratePictureUploadUrlRequest":{"type":"object","properties":{"contactId":{"description":"ID of the contact whose picture is being updated.","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mimeType":{"description":"Mime Type. Must be one of:\n`image/png`, `image/jpeg`.\nDefaults to `image/png`.","title":"mimeType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GeneratePictureUploadUrlRequest","description":""},"com.wixpress.contacts.core.api.v4.GeneratePictureUploadUrlResponse":{"type":"object","properties":{"uploadUrl":{"description":"URL to upload the image","format":"WEB_URL","title":"uploadUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GeneratePictureUploadUrlResponse","description":""},"com.wixpress.contacts.core.api.v4.GetContactRequest":{"type":"object","properties":{"id":{"description":"ID of the contact to retrieve.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"List of projected fields to return.\nIf both `fields` and `fieldsets` are sent in the request,\nthe union of both lists is returned.\n`id` and `revision` are always returned.\n\nSupported properties:\n`source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,\n`info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,\n`info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,\n`info.labelKeys`, `info.locations`, `info.extendedFields`","maxLength":100,"maxItems":100,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"Predefined sets of fields to return.\nIf both `fields` and `fieldsets` are sent in the request,\nthe union of both lists is returned.\n\n- `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.\n- `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.\n- `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.\n- `FULL`: Returns all fields.\n\nDefault: If `fields` is omitted from the request, `FULL`.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactFieldSet"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetContactRequest","description":""},"com.wixpress.contacts.core.api.v4.GetContactResponse":{"type":"object","properties":{"contact":{"description":"The requested contact.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"responseType":{"description":"Contact response type.\n\n- `REGULAR`: The specified contact was returned.\n- `IMPLICIT`: Not used.\n- `MERGED`: The specified contact was previously merged with another contact, and the new contact was","title":"responseType","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.GetContactResponse.GetContactResponseType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetContactResponse","description":"The requested contact."},"com.wixpress.contacts.core.api.v4.GetContactResponse.GetContactResponseType":{"type":"string","description":"","title":"GetContactResponseType","enum":["REGULAR","IMPLICIT","MERGED"]},"com.wixpress.contacts.core.api.v4.SyncSubmitContactRequest":{"type":"object","properties":{"contactInfo":{"description":"","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactInfo","summary":"contactInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activity":{"description":"","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactActivity","summary":"activity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"passThroughData":{"description":"","title":"passThroughData","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactId":{"description":"","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"submitOperation":{"description":"","title":"submitOperation","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.SyncSubmitContactRequest.SubmitOperation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sourceType":{"description":"Need to resolve source in allocator, because of server sign","title":"sourceType","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.ContactSource.ContactSourceType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sourceId":{"description":"","title":"sourceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hideFromContactList":{"description":"","title":"hideFromContactList","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SyncSubmitContactRequest","description":""},"com.wixpress.contacts.core.api.v4.SyncSubmitContactRequest.SubmitOperation":{"type":"string","description":"","title":"SubmitOperation","enum":["UNKNOWN","CREATE","UPDATE"]},"com.wixpress.contacts.core.api.v4.SyncSubmitContactResponse":{"type":"object","properties":{},"title":"SyncSubmitContactResponse","description":""},"com.wixpress.contacts.core.api.v4.CountContactsRequest":{"type":"object","properties":{},"title":"CountContactsRequest","description":""},"com.wixpress.contacts.core.api.v4.CountContactsResponse":{"type":"object","properties":{"count":{"description":"","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountContactsResponse","description":""},"com.wixpress.contacts.core.api.v4.SearchContactsRequest":{"type":"object","properties":{"search":{"description":"Search object. Encapsulates filter, sorting, paging and other details","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.query.Search","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchContactsRequest","description":""},"com.wixpress.contacts.core.api.v4.upstream.wix.query.Search":{"type":"object","properties":{"filter":{"description":"A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the form [{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]","title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"List of projected fields to return.\n\nIf used in the request,\nall the fields contained in `fields` and `fieldsets` are returned.\nIf left blank, `fieldsets` is used to determine which fields to return.\n\nFor a list of valid projected fields, see\n[Valid Contact Projection Fields](https://dev.wix.com/api/rest/contacts/contacts/fieldsets-and-projected-fields#contacts_contacts_fieldsets-and-projected-fields_valid-contact-projection-fields).","maxLength":100,"maxItems":100,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"Predefined sets of fields to return.\n\nDefaults to `FULL`.\nIgnored if left empty when `fields` is used in the request.\n\nFor more information,\nsee [Contact Fieldsets](https://dev.wix.com/api/rest/contacts/contacts/fieldsets-and-projected-fields#contacts_contacts_fieldsets-and-projected-fields_contact-fieldsets).","maxItems":10,"title":"fieldsets","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"free text to match in searchable fields","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.query.SearchDetails","summary":"search","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Search","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.query.Search.pagingMethod"}]},"com.wixpress.contacts.core.api.v4.upstream.wix.query.Search.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor pointing to page of results. 'cursorPaging.cursor' can not be used together with 'filter' or 'sort'","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.contacts.core.api.v4.upstream.wix.query.SearchDetails":{"type":"object","properties":{"mode":{"description":"boolean search mode. Default is `OR`","title":"mode","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.query.SearchDetails.Mode","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expression":{"description":"search term or expression","maxLength":100,"title":"expression","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"fields to search in. if empty - server will search in own default fieldsDefault searchable fields:\n\n- `info.name.first`\n- `info.name.last`\n- `info.emails.email`\n- `info.phones.phone`","maxLength":100,"maxItems":100,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fuzzy":{"description":"flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)","title":"fuzzy","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchDetails","description":""},"com.wixpress.contacts.core.api.v4.upstream.wix.query.SearchDetails.Mode":{"type":"string","description":"","title":"Mode","enum":["OR","AND"]},"com.wixpress.contacts.core.api.v4.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"The number of contacts to load (default = 50, max = 1000)","minimum":0,"maximum":1000,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Cursor returned in last query response. Should not be provided on first page request","title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"com.wixpress.contacts.core.api.v4.SearchContactsResponse":{"type":"object","properties":{"contacts":{"description":"List of contacts.","title":"contacts","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchContactsResponse","description":""},"com.wixpress.contacts.core.api.v4.upstream.wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"The number of items returned in this response","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"The offset which was requested. Returned if offset paging was used","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"The total number of items that match the query. Returned if offset paging was used and 'too_many_to_count' flag is not set","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"A flag that indicates the server failed to calculate 'total' field","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through result pages. Returned if cursor paging was used","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"com.wixpress.contacts.core.api.v4.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor pointing to next result page","title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to previous result page","title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wixpress.contacts.core.api.v4.BulkAddSegmentToContactsRequest":{"type":"object","properties":{"segmentId":{"description":"Segment id","format":"GUID","title":"segmentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactIds":{"description":"List of Contact ids","format":"GUID","minItems":1,"maxItems":1000,"title":"contactIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"existsSegmentIds":{"description":"List of existing segment ids","format":"GUID","maxItems":100,"title":"existsSegmentIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAddSegmentToContactsRequest","description":""},"com.wixpress.contacts.core.api.v4.BulkAddSegmentToContactsResponse":{"type":"object","properties":{"results":{"description":"List of action results","title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.common.ItemMetadata"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Metadata on the bulk action","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkAddSegmentToContactsResponse","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"com.wixpress.contacts.core.api.v4.events.ContactAddedToSegment":{"type":"object","properties":{"segmentId":{"description":"Id of the segment to which the contact was added","title":"segmentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contact":{"description":"The contact that was added","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactAddedToSegment","description":""},"com.wixpress.contacts.core.api.v4.BulkRemoveSegmentFromContactsRequest":{"type":"object","properties":{"segmentId":{"description":"Segment id","format":"GUID","title":"segmentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactIds":{"description":"List of Contact ids","format":"GUID","minItems":1,"maxItems":1000,"title":"contactIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveSegmentFromContactsRequest","description":""},"com.wixpress.contacts.core.api.v4.BulkRemoveSegmentFromContactsResponse":{"type":"object","properties":{"results":{"description":"List of action results","title":"results","type":"array","items":{"$ref":"#/components/schemas/wix.common.ItemMetadata"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Metadata on the bulk action","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkRemoveSegmentFromContactsResponse","description":""},"com.wixpress.contacts.core.api.v4.events.ContactRemovedFromSegment":{"type":"object","properties":{"segmentId":{"description":"Id of the segment from which the contact was removed","title":"segmentId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contact":{"description":"The contact that was removed","$ref":"#/components/schemas/com.wixpress.contacts.core.api.v4.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactRemovedFromSegment","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Contact","description":"","fqdn":"wix.contacts.v4.contact"},"articles":[{"displayName":"Sort, Filter, and Search","slugifyName":"sort-filter-and-search","content":"\n# Contacts: Supported Filters, Sorting, and Search\n\nThis article covers field support for filtering, sorting, and searching\nin the Contacts API,\nincluding for extended fields.\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\n| Field | Supported Filters | Sortable | Searchable |\n|-------------------------------------|-----------------------------------------------|----------|------------|\n| `id` | `$eq`, `$ne`, `$in`, `$exists` | | |\n| `createdDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable | |\n| `updatedDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | | |\n| `lastActivity.activityDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable | |\n| `primaryInfo.email` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | Sortable | |\n| `primaryInfo.phone` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | | |\n| `info.name.first` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | Sortable | Searchable |\n| `info.name.last` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | Sortable | Searchable |\n| `info.emails.email` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | | Searchable |\n| `info.phones.phone` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | | Searchable |\n| `info.phones.e164Phone` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | | Searchable |\n| `info.addresses.street` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | | |\n| `info.addresses.city` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | | |\n| `info.addresses.subdivision` | `$eq`, `$ne`, `$in`, `$exists` | | |\n| `info.addresses.country` | `$eq`, `$ne`, `$in`, `$exists` | | |\n| `info.company` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | Sortable | |\n| `info.jobTitle` | `$eq`, `$ne`, `$in`, `$exists`, `$startsWith` | Sortable | |\n| `info.birthdate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable | |\n| `info.locale` | `$eq`, `$ne`, `$in`, `$exists` | | |\n| `info.labelKeys` | `$hasSome`, `$hasAll` | | |\n| `info.locations` | `$hasSome`, `$hasAll` | | |\n\n## Extended Fields: Supported filters, sorting, and search\n\nThe table below shows field support for filters, sorting,\nand free-text searching\nfor the Wix-defined extended fields (also known as system 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 `emailSubscriptions.effectiveEmail` extended field,\n> use this flattened field name:\n> `\"info.extendedFields.emailSubscriptions.effectiveEmail\"`.\n\n| Field | Supported Filters | Sortable | Searchable |\n| ----------------------------------------- | ------------------------- | -------- | ---------- |\n| `invoices.vatId` | | | |\n| `members.membershipStatus` | `$eq`,`$ne`,`$in`, `$nin` | | |\n| `emailSubscriptions.deliverabilityStatus` | `$eq`,`$ne`,`$in`, `$nin` | | |\n| `emailSubscriptions.subscriptionStatus` | `$eq`,`$ne`,`$in`, `$nin` | | |\n| `emailSubscriptions.effectiveEmail` | `$exists` | Sortable | |\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_.\nSite contributors can add, remove, and change custom field names\nfrom the\n[Contact List](fallback::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 their site's Dashboard.\n\nThe table below shows field support for filters, sorting,\nand free-text searching\nfor 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.newCustomer` extended field,\n> use this flattened field name:\n> `\"info.extendedFields.custom.newCustomer\"`.\n\n| Data Type/Format | Supported Filters | Sortable |\n| ---------------------------------- | ------------------------------------------ | -------- |\n| String | `$eq`, `$ne`, `$in`, `$startsWith` | Sortable |\n| Number | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| Date string in `YYYY-MM-DD` format | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Contacts](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::874fc7dd-ac32-4d57-8b43-3166eff8f210slug::query-contacts*fallback::https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts)\n"},{"displayName":"Last Activity Types","slugifyName":"last-activity-types","content":"# Last Activity Types\n\nWhen a contact interacts with a 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| `NEWSLETTER_SUBSCRIPTION_SUBSCRIBE` | Subscribed to a site newsletter. |\n| `NEWSLETTER_SUBSCRIPTION_PENDING` | Subscription status to site newsletters is pending confirmation. |\n| `NEWSLETTER_SUBSCRIPTION_NOT_SET` | Subscription status to site newsletters is not set. |\n\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Query Facets

Permission Scopes