{"id":"98ac252f-f83d-49f5-94e0-dcab6205f95f","createdDate":"2024-07-07T11:49:15.594Z","updatedDate":"2024-07-07T11:49:15.594Z","resourceId":"352423a5-a831-4915-bbd1-1fa31993c5cd","api":{"schema":{"object":{"displayName":"Extended Field Object","description":"Extended field that was found or created.","slug":"extended-field-object","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField","legacyExamples":[{"title":"ExtendedField","content":"{\n \"namespace\" : \"custom\",\n \"key\": \"custom.my-field\",\n \"displayName\": \"My Field\",\n \"dataType\": \"TEXT\",\n \"fieldType\" : \"USER_DEFINED\",\n \"createdDate\": \"2019-10-10T12:30:56Z\",\n \"updatedDate\": \"2020-05-10T07:14:59Z\"\n}\n"}],"sourceRepo":"git@github.com:wix-private/crm.git"},"methods":[{"summary":"List Extended Fields","description":"Retrieves a list of extended fields.","operationId":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.ListExtendedFields","parameters":[{"name":"fieldType","in":"query","description":"Filter for fields of the specified type.","required":false,"schema":{"description":"Filter for fields of the specified type.","title":"fieldType","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField.FieldType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"namespace","in":"query","description":"Filter for fields in the specified namespace.\nFields created by site contributors or 3rd-party apps\nare automatically assigned to the `custom` namespace.","required":false,"schema":{"description":"Filter for fields in the specified namespace.\nFields created by site contributors or 3rd-party apps\nare automatically assigned to the `custom` namespace.","minLength":3,"maxLength":25,"title":"namespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"startsWith","in":"query","description":"Filter for fields where `displayName` starts with the specified case-sensitive string.","required":false,"schema":{"description":"Filter for fields where `displayName` starts with the specified case-sensitive string.","maxLength":150,"title":"startsWith","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"sort","in":"query","description":"Sorting options.","required":false,"schema":{"description":"Sorting options.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.upstream.wix.common.Sorting","summary":"sort","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"paging","in":"query","description":"Paging options.","required":false,"schema":{"description":"Paging options.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ListExtendedFieldsResponse","description":"List of extended fields."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/extended-fields","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/extended-fields","destinationPath":"/v4/extended-fields","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS_SCHEMA.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-fields-app","serviceArtifactId":"com.wixpress.contacts.contacts-fields-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.fields.v4.ListExtendedFieldsRequest","responseMessage":"com.wixpress.contacts.fields.v4.ListExtendedFieldsResponse"},"legacyExamples":[{"name":"ListExtendedFields","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","content":{"title":"List Extended Fields","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/extended-fields' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"fields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.number\",\n \"displayName\": \"number\",\n \"dataType\": \"NUMBER\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2021-01-06T12:57:04Z\",\n \"updatedDate\": \"2021-01-06T12:57:04Z\",\n \"legacyId\": \"5c55ce7e-ca4b-4332-b666-1e00d06e4555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.website\",\n \"displayName\": \"Website\",\n \"dataType\": \"URL\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-07-02T10:29:41Z\",\n \"updatedDate\": \"2020-07-02T10:29:41Z\",\n \"legacyId\": \"0a272857-4d0b-4ce2-bac6-1e3ce4483555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.date\",\n \"displayName\": \"Date\",\n \"dataType\": \"DATE\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-07-02T10:29:38Z\",\n \"updatedDate\": \"2020-07-02T10:29:38Z\",\n \"legacyId\": \"d104a3ad-f87f-4a79-9b3c-1bca5f41a555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.groupcolor\",\n \"displayName\": \"groupColor\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-03-26T10:01:38Z\",\n \"updatedDate\": \"2020-03-26T10:01:38Z\",\n \"legacyId\": \"bb133f4f-67f1-44db-89e8-ea24e471d555\"\n },\n {\n \"namespace\": \"contacts\",\n \"key\": \"contacts.displayByFirstName\",\n \"displayName\": \"Display Name (start with first)\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Display name starting with first name (read only)\"\n },\n {\n \"namespace\": \"contacts\",\n \"key\": \"contacts.displayByLastName\",\n \"displayName\": \"Display Name (start with last)\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Display name starting with last name (read only)\"\n },\n {\n \"namespace\": \"invoices\",\n \"key\": \"invoices.vatId\",\n \"displayName\": \"VAT ID\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Vat ID for Wix Invoices\"\n },\n {\n \"namespace\": \"members\",\n \"key\": \"members.membershipStatus\",\n \"displayName\": \"Membership Status\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"APPROVED/DENIED/PENDING/INACTIVE (read only)\"\n },\n {\n \"namespace\": \"members\",\n \"key\": \"members.mobile\",\n \"displayName\": \"Mobile flag\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"true/false\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.numOfPurchases\",\n \"displayName\": \"# of Purchases\",\n \"dataType\": \"NUMBER\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores purchase count (read only)\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.totalSpentAmount\",\n \"displayName\": \"Total Spent Amount\",\n \"dataType\": \"NUMBER\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores aggregated spent amount (read only)\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.totalSpentCurrency\",\n \"displayName\": \"Total Spent Currency\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores currency code (read only)\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.lastPurchaseDate\",\n \"displayName\": \"Last Purchase Date\",\n \"dataType\": \"DATE\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores last purchase date (read only)\"\n },\n {\n \"namespace\": \"emailSubscriptions\",\n \"key\": \"emailSubscriptions.subscriptionStatus\",\n \"displayName\": \"Effective Subscription Status\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"SUBSCRIBED/UNSUBSCRIBED/NOT_SET/PENDING (read only)\"\n },\n {\n \"namespace\": \"emailSubscriptions\",\n \"key\": \"emailSubscriptions.deliverabilityStatus\",\n \"displayName\": \"Effective Deliverability Status\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"VALID/BOUNCED/SPAM_COMPLAINT/INACTIVE (read only)\"\n },\n {\n \"namespace\": \"emailSubscriptions\",\n \"key\": \"emailSubscriptions.effectiveEmail\",\n \"displayName\": \"Effective Email\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Effective Email for subscription purposes (read only)\"\n }\n ],\n \"metadata\": {\n \"count\": 16,\n \"offset\": 0,\n \"total\": 16,\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"get","path":"/v4/extended-fields","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS_SCHEMA.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-fields-app","serviceArtifactId":"com.wixpress.contacts.contacts-fields-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.fields.v4.ListExtendedFieldsRequest","responseMessage":"com.wixpress.contacts.fields.v4.ListExtendedFieldsResponse"},"legacyExamples":[{"name":"ListExtendedFields","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","content":{"title":"List Extended Fields","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/extended-fields' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"fields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.number\",\n \"displayName\": \"number\",\n \"dataType\": \"NUMBER\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2021-01-06T12:57:04Z\",\n \"updatedDate\": \"2021-01-06T12:57:04Z\",\n \"legacyId\": \"5c55ce7e-ca4b-4332-b666-1e00d06e4555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.website\",\n \"displayName\": \"Website\",\n \"dataType\": \"URL\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-07-02T10:29:41Z\",\n \"updatedDate\": \"2020-07-02T10:29:41Z\",\n \"legacyId\": \"0a272857-4d0b-4ce2-bac6-1e3ce4483555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.date\",\n \"displayName\": \"Date\",\n \"dataType\": \"DATE\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-07-02T10:29:38Z\",\n \"updatedDate\": \"2020-07-02T10:29:38Z\",\n \"legacyId\": \"d104a3ad-f87f-4a79-9b3c-1bca5f41a555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.groupcolor\",\n \"displayName\": \"groupColor\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-03-26T10:01:38Z\",\n \"updatedDate\": \"2020-03-26T10:01:38Z\",\n \"legacyId\": \"bb133f4f-67f1-44db-89e8-ea24e471d555\"\n },\n {\n \"namespace\": \"contacts\",\n \"key\": \"contacts.displayByFirstName\",\n \"displayName\": \"Display Name (start with first)\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Display name starting with first name (read only)\"\n },\n {\n \"namespace\": \"contacts\",\n \"key\": \"contacts.displayByLastName\",\n \"displayName\": \"Display Name (start with last)\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Display name starting with last name (read only)\"\n },\n {\n \"namespace\": \"invoices\",\n \"key\": \"invoices.vatId\",\n \"displayName\": \"VAT ID\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Vat ID for Wix Invoices\"\n },\n {\n \"namespace\": \"members\",\n \"key\": \"members.membershipStatus\",\n \"displayName\": \"Membership Status\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"APPROVED/DENIED/PENDING/INACTIVE (read only)\"\n },\n {\n \"namespace\": \"members\",\n \"key\": \"members.mobile\",\n \"displayName\": \"Mobile flag\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"true/false\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.numOfPurchases\",\n \"displayName\": \"# of Purchases\",\n \"dataType\": \"NUMBER\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores purchase count (read only)\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.totalSpentAmount\",\n \"displayName\": \"Total Spent Amount\",\n \"dataType\": \"NUMBER\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores aggregated spent amount (read only)\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.totalSpentCurrency\",\n \"displayName\": \"Total Spent Currency\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores currency code (read only)\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.lastPurchaseDate\",\n \"displayName\": \"Last Purchase Date\",\n \"dataType\": \"DATE\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores last purchase date (read only)\"\n },\n {\n \"namespace\": \"emailSubscriptions\",\n \"key\": \"emailSubscriptions.subscriptionStatus\",\n \"displayName\": \"Effective Subscription Status\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"SUBSCRIBED/UNSUBSCRIBED/NOT_SET/PENDING (read only)\"\n },\n {\n \"namespace\": \"emailSubscriptions\",\n \"key\": \"emailSubscriptions.deliverabilityStatus\",\n \"displayName\": \"Effective Deliverability Status\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"VALID/BOUNCED/SPAM_COMPLAINT/INACTIVE (read only)\"\n },\n {\n \"namespace\": \"emailSubscriptions\",\n \"key\": \"emailSubscriptions.effectiveEmail\",\n \"displayName\": \"Effective Email\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Effective Email for subscription purposes (read only)\"\n }\n ],\n \"metadata\": {\n \"count\": 16,\n \"offset\": 0,\n \"total\": 16,\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"List Extended Fields","slugifiedName":"list-extended-fields"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Find Or Create Extended Field","description":"Retrieves a custom field with a given name, or creates one if it doesn't exist.\nThe number of custom fields is limited to 100.\n\nSuccessful calls to this endpoint always return a field,\nwhich can be passed to subsequent requests.\n\nTo find an existing custom field without potentially creating a new one, use\n[Get Extended Field](https:dev.wix.com/api/rest/contacts/extended-fields/get-extended-field) or\n[List Extended Fields](https:dev.wix.com/api/rest/contacts/extended-fields/list-extended-fields).","operationId":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.FindOrCreateExtendedField","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.FindOrCreateExtendedFieldResponse","description":"Extended field that was found or created."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/extended-fields","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/extended-fields","destinationPath":"/v4/extended-fields","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"FindOrCreateExtendedFieldRequest","description":"Custom field to find or create.","properties":{"displayName":{"description":"Display name to find or create.\n\nIf an existing custom field is an exact match\nfor the specified `displayName`,\nthe existing field is returned.\nIf not, a new field is created and returned.","minLength":1,"maxLength":150,"title":"displayName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataType":{"description":"Type of data the field holds.\nIgnored if an existing field is an exact match\nfor the specified display name.\n\n- `TEXT`: Accepts strings.\n- `NUMBER`: Accepts floats.\n- `DATE`: Accepts dates formatted as `YYYY-MM-DD`.\n- `URL`: Accepts strings. Prepends `https://` if no protocol is included.","title":"dataType","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField.FieldDataType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["displayName"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Extended Field Created","description":"Triggered when an extended field is created.","permissions":["CONTACTS_SCHEMA.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.contacts.v4.extended-field","serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.extended-field_created","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","errors":[{"httpCode":429,"statusCode":"RESOURCE_EXHAUSTED","applicationCode":"FIELDS_QUOTA_EXCEEDED"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS_SCHEMA.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-fields-app","serviceArtifactId":"com.wixpress.contacts.contacts-fields-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.fields.v4.FindOrCreateExtendedFieldRequest","responseMessage":"com.wixpress.contacts.fields.v4.FindOrCreateExtendedFieldResponse"},"legacyExamples":[{"name":"FindOrCreateExtendedField","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","content":{"title":"Find or Create Extended Field","request":"curl -X POST 'https://www.wixapis.com/contacts/v4/extended-fields' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"displayName\": \"My Field\"\n \"dataType\" : \"TEXT\"\n }'","response":"{\n \"field\": {\n \"namespace\": \"custom\",\n \"key\": \"custom.my-field\",\n \"displayName\": \"My Field\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-05-10T07:14:59Z\",\n \"updatedDate\": \"2020-05-10T07:14:59Z\"\n },\n \"newField\": true\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v4/extended-fields","rpcOnly":false,"triggeredEvents":[{"title":"Extended Field Created","description":"Triggered when an extended field is created.","permissions":["CONTACTS_SCHEMA.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.contacts.v4.extended-field","serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.extended-field_created","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","errors":[{"httpCode":429,"statusCode":"RESOURCE_EXHAUSTED","applicationCode":"FIELDS_QUOTA_EXCEEDED"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS_SCHEMA.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-fields-app","serviceArtifactId":"com.wixpress.contacts.contacts-fields-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.fields.v4.FindOrCreateExtendedFieldRequest","responseMessage":"com.wixpress.contacts.fields.v4.FindOrCreateExtendedFieldResponse"},"legacyExamples":[{"name":"FindOrCreateExtendedField","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","content":{"title":"Find or Create Extended Field","request":"curl -X POST 'https://www.wixapis.com/contacts/v4/extended-fields' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"displayName\": \"My Field\"\n \"dataType\" : \"TEXT\"\n }'","response":"{\n \"field\": {\n \"namespace\": \"custom\",\n \"key\": \"custom.my-field\",\n \"displayName\": \"My Field\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-05-10T07:14:59Z\",\n \"updatedDate\": \"2020-05-10T07:14:59Z\"\n },\n \"newField\": true\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Find Or Create Extended Field","slugifiedName":"find-or-create-extended-field"},"permissionScopes":[{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"}]},{"summary":"Get Extended Field","description":"Retrieves an extended field.","operationId":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.GetExtendedField","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"key","description":"Extended field key.\n\nWhen accessing contact data,\nextended field values are available at `info.extendedFields.items[key]`.\nFor example, if the key is \"custom.patronus\",\nthe value can be accessed at `info.extendedFields.items[\"custom.patronus\"]`.\n\nOnce set, `key` cannot be modified, even if `displayName` changes.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.GetExtendedFieldResponse","description":"The specified field."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/extended-fields","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/extended-fields","destinationPath":"/v4/extended-fields","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS_SCHEMA.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-fields-app","serviceArtifactId":"com.wixpress.contacts.contacts-fields-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.fields.v4.GetExtendedFieldRequest","responseMessage":"com.wixpress.contacts.fields.v4.GetExtendedFieldResponse"},"legacyExamples":[{"name":"GetExtendedField","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","content":{"title":"Get Extended Field","request":"curl -X GET 'https://www.wixapis.com/contacts/v4/extended-fields/custom.my-field' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"namespace\" : \"custom\",\n \"key\": \"custom.my-field\",\n \"displayName\": \"My Field\",\n \"dataType\": \"TEXT\",\n \"fieldType\" : \"USER_DEFINED\",\n \"createdDate\": \"2019-10-10T12:30:56Z\",\n \"updatedDate\": \"2020-05-10T07:14:59Z\"\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"get","path":"/v4/extended-fields/{key}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS_SCHEMA.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-fields-app","serviceArtifactId":"com.wixpress.contacts.contacts-fields-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.fields.v4.GetExtendedFieldRequest","responseMessage":"com.wixpress.contacts.fields.v4.GetExtendedFieldResponse"},"legacyExamples":[{"name":"GetExtendedField","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","content":{"title":"Get Extended Field","request":"curl -X GET 'https://www.wixapis.com/contacts/v4/extended-fields/custom.my-field' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"namespace\" : \"custom\",\n \"key\": \"custom.my-field\",\n \"displayName\": \"My Field\",\n \"dataType\": \"TEXT\",\n \"fieldType\" : \"USER_DEFINED\",\n \"createdDate\": \"2019-10-10T12:30:56Z\",\n \"updatedDate\": \"2020-05-10T07:14:59Z\"\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Get Extended Field","slugifiedName":"get-extended-field"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Delete Extended Field","description":"Deletes an extended field.\n\nWhen an extended field is deleted,\nany contact data stored in the field is permanently deleted as well.","operationId":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.DeleteExtendedField","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"key","description":"Extended field key.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.DeleteExtendedFieldResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/extended-fields","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/extended-fields","destinationPath":"/v4/extended-fields","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Extended Field Deleted","description":"Triggered when an extended field is deleted.","permissions":["CONTACTS_SCHEMA.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.contacts.v4.extended-field","serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.extended-field_deleted","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS_SCHEMA.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-fields-app","serviceArtifactId":"com.wixpress.contacts.contacts-fields-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.fields.v4.DeleteExtendedFieldRequest","responseMessage":"com.wixpress.contacts.fields.v4.DeleteExtendedFieldResponse"},"legacyExamples":[{"name":"DeleteExtendedField","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","content":{"title":"Delete Extended Field","request":"curl -X DELETE 'https://www.wixapis.com/contacts/v4/extended-fields/custom.my-field' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{ }"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"delete","path":"/v4/extended-fields/{key}","rpcOnly":false,"triggeredEvents":[{"title":"Extended Field Deleted","description":"Triggered when an extended field is deleted.","permissions":["CONTACTS_SCHEMA.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.contacts.v4.extended-field","serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.extended-field_deleted","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS_SCHEMA.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-fields-app","serviceArtifactId":"com.wixpress.contacts.contacts-fields-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.fields.v4.DeleteExtendedFieldRequest","responseMessage":"com.wixpress.contacts.fields.v4.DeleteExtendedFieldResponse"},"legacyExamples":[{"name":"DeleteExtendedField","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","content":{"title":"Delete Extended Field","request":"curl -X DELETE 'https://www.wixapis.com/contacts/v4/extended-fields/custom.my-field' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{ }"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Delete Extended Field","slugifiedName":"delete-extended-field"},"permissionScopes":[{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"}]},{"summary":"Update Extended Field","description":"Updates an extended field's specified properties.","operationId":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.UpdateExtendedField","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"field.key","description":"Extended field key.\n\nWhen accessing contact data,\nextended field data is available at `extendedFields[key]`.\nFor example, if the key is \"custom.notes\",\nthe value can be accessed at `extendedFields[\"custom.notes\"]`.\n\n`key` is generated when the extended field is created\nand cannot be modified, even if `displayName` changes.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.UpdateExtendedFieldResponse","description":"Updated extended field."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/extended-fields","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/extended-fields","destinationPath":"/v4/extended-fields","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateExtendedFieldRequest","description":"","properties":{"field":{"description":"Field to update.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField","summary":"field","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["field.key","field.displayName"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Extended Field Updated","description":"Triggered when an extended field is updated.","permissions":["CONTACTS_SCHEMA.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.extended-field","serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.extended-field_updated","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS_SCHEMA.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-fields-app","serviceArtifactId":"com.wixpress.contacts.contacts-fields-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.fields.v4.UpdateExtendedFieldRequest","responseMessage":"com.wixpress.contacts.fields.v4.UpdateExtendedFieldResponse"},"legacyExamples":[{"name":"UpdateExtendedField","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","content":{"title":"Update Extended Field","request":"curl -X PATCH 'https://www.wixapis.com/contacts/v4/extended-fields/custom.my-field'\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"name\": \"My New Field Name\"\n }'","response":"{\n \"namespace\" : \"custom\",\n \"key\": \"custom.my-field\",\n \"displayName\": \"My New Field Name\",\n \"dataType\": \"TEXT\",\n \"fieldType\" : \"USER_DEFINED\",\n \"createdDate\": \"2019-10-10T12:30:56Z\",\n \"updatedDate\": \"2020-05-10T07:14:59Z\"\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"patch","path":"/v4/extended-fields/{field.key}","rpcOnly":false,"triggeredEvents":[{"title":"Extended Field Updated","description":"Triggered when an extended field is updated.","permissions":["CONTACTS_SCHEMA.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.extended-field","serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.contacts.v4.extended-field_updated","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS_SCHEMA.MODIFY"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-fields-app","serviceArtifactId":"com.wixpress.contacts.contacts-fields-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.fields.v4.UpdateExtendedFieldRequest","responseMessage":"com.wixpress.contacts.fields.v4.UpdateExtendedFieldResponse"},"legacyExamples":[{"name":"UpdateExtendedField","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","content":{"title":"Update Extended Field","request":"curl -X PATCH 'https://www.wixapis.com/contacts/v4/extended-fields/custom.my-field'\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"name\": \"My New Field Name\"\n }'","response":"{\n \"namespace\" : \"custom\",\n \"key\": \"custom.my-field\",\n \"displayName\": \"My New Field Name\",\n \"dataType\": \"TEXT\",\n \"fieldType\" : \"USER_DEFINED\",\n \"createdDate\": \"2019-10-10T12:30:56Z\",\n \"updatedDate\": \"2020-05-10T07:14:59Z\"\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Update Extended Field","slugifiedName":"update-extended-field"},"permissionScopes":[{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"}]},{"summary":"Query Extended Fields","description":"Retrieves a list of extended fields.\n\nFor a detailed list of supported operations, see [sorting and filtering for extended fields](https://dev.wix.com/api/rest/contacts/extended-fields/sort-and-filter). To learn more about query language, see\n[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).","operationId":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4.QueryExtendedFields","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.QueryExtendedFieldsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/extended-fields","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/extended-fields","destinationPath":"/v4/extended-fields","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryExtendedFieldsRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.upstream.wix.query.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_SORT"},{"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"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_FILTER_OPERATOR"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_FILTER_VALUE"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS_SCHEMA.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-fields-app","serviceArtifactId":"com.wixpress.contacts.contacts-fields-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.fields.v4.QueryExtendedFieldsRequest","responseMessage":"com.wixpress.contacts.fields.v4.QueryExtendedFieldsResponse"},"legacyExamples":[{"name":"QueryExtendedFields","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","order":1,"content":{"title":"Query All Extended Fields","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/extended-fields/query' \\\n -H 'Authorization: '","response":"{\n \"fields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.number\",\n \"displayName\": \"number\",\n \"dataType\": \"NUMBER\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2021-01-06T12:57:04Z\",\n \"updatedDate\": \"2021-01-06T12:57:04Z\",\n \"legacyId\": \"5c55ce7e-ca4b-4332-b666-1e00d06e4555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.website\",\n \"displayName\": \"Website\",\n \"dataType\": \"URL\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-07-02T10:29:41Z\",\n \"updatedDate\": \"2020-07-02T10:29:41Z\",\n \"legacyId\": \"0a272857-4d0b-4ce2-bac6-1e3ce4483555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.date\",\n \"displayName\": \"Date\",\n \"dataType\": \"DATE\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-07-02T10:29:38Z\",\n \"updatedDate\": \"2020-07-02T10:29:38Z\",\n \"legacyId\": \"d104a3ad-f87f-4a79-9b3c-1bca5f41a555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.groupcolor\",\n \"displayName\": \"groupColor\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-03-26T10:01:38Z\",\n \"updatedDate\": \"2020-03-26T10:01:38Z\",\n \"legacyId\": \"bb133f4f-67f1-44db-89e8-ea24e471d555\"\n },\n {\n \"namespace\": \"contacts\",\n \"key\": \"contacts.displayByFirstName\",\n \"displayName\": \"Display Name (start with first)\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Display name starting with first name (read only)\"\n },\n {\n \"namespace\": \"contacts\",\n \"key\": \"contacts.displayByLastName\",\n \"displayName\": \"Display Name (start with last)\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Display name starting with last name (read only)\"\n },\n {\n \"namespace\": \"invoices\",\n \"key\": \"invoices.vatId\",\n \"displayName\": \"VAT ID\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Vat ID for Wix Invoices\"\n },\n {\n \"namespace\": \"members\",\n \"key\": \"members.membershipStatus\",\n \"displayName\": \"Membership Status\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"APPROVED/DENIED/PENDING/INACTIVE (read only)\"\n },\n {\n \"namespace\": \"members\",\n \"key\": \"members.mobile\",\n \"displayName\": \"Mobile flag\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"true/false\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.numOfPurchases\",\n \"displayName\": \"# of Purchases\",\n \"dataType\": \"NUMBER\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores purchase count (read only)\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.totalSpentAmount\",\n \"displayName\": \"Total Spent Amount\",\n \"dataType\": \"NUMBER\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores aggregated spent amount (read only)\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.totalSpentCurrency\",\n \"displayName\": \"Total Spent Currency\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores currency code (read only)\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.lastPurchaseDate\",\n \"displayName\": \"Last Purchase Date\",\n \"dataType\": \"DATE\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores last purchase date (read only)\"\n },\n {\n \"namespace\": \"emailSubscriptions\",\n \"key\": \"emailSubscriptions.subscriptionStatus\",\n \"displayName\": \"Effective Subscription Status\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"SUBSCRIBED/UNSUBSCRIBED/NOT_SET/PENDING (read only)\"\n },\n {\n \"namespace\": \"emailSubscriptions\",\n \"key\": \"emailSubscriptions.deliverabilityStatus\",\n \"displayName\": \"Effective Deliverability Status\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"VALID/BOUNCED/SPAM_COMPLAINT/INACTIVE (read only)\"\n },\n {\n \"namespace\": \"emailSubscriptions\",\n \"key\": \"emailSubscriptions.effectiveEmail\",\n \"displayName\": \"Effective Email\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Effective Email for subscription purposes (read only)\"\n }\n ],\n \"metadata\": {\n \"count\": 16,\n \"offset\": 0,\n \"total\": 16,\n }\n}"}},{"name":"QueryExtendedFields","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","order":2,"content":{"title":"Query Extended Fields by Namespace Sorted by CreatedDate Desc","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/extended-fields/query' \\\n -H 'Authorization: '\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"namespace\" : \"custom\"\n },\n \"sort\" : [\n {\"fieldName\": \"createdDate\", \"order\" : \"DESC\"}\n ]\n }\n }'","response":"{\n \"fields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.number\",\n \"displayName\": \"number\",\n \"dataType\": \"NUMBER\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2021-01-06T12:57:04Z\",\n \"updatedDate\": \"2021-01-06T12:57:04Z\",\n \"legacyId\": \"5c55ce7e-ca4b-4332-b666-1e00d06e4555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.website\",\n \"displayName\": \"Website\",\n \"dataType\": \"URL\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-07-02T10:29:41Z\",\n \"updatedDate\": \"2020-07-02T10:29:41Z\",\n \"legacyId\": \"0a272857-4d0b-4ce2-bac6-1e3ce4483555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.date\",\n \"displayName\": \"Date\",\n \"dataType\": \"DATE\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-07-02T10:29:38Z\",\n \"updatedDate\": \"2020-07-02T10:29:38Z\",\n \"legacyId\": \"d104a3ad-f87f-4a79-9b3c-1bca5f41a555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.groupcolor\",\n \"displayName\": \"groupColor\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-03-26T10:01:38Z\",\n \"updatedDate\": \"2020-03-26T10:01:38Z\",\n \"legacyId\": \"bb133f4f-67f1-44db-89e8-ea24e471d555\"\n }\n ],\n \"metadata\": {\n \"count\": 4,\n \"offset\": 0,\n \"total\": 4,\n }\n}"}},{"name":"QueryExtendedFields","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","order":3,"content":{"title":"Query Extended Fields by Keys","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/extended-fields/query' \\\n -H 'Authorization: '\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"key\" : {\n \"$in\" : [\"custom.date\", \"emailSubscriptions.effectiveEmail\"]\n }\n }\n }\n }'","response":"{\n \"fields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.date\",\n \"displayName\": \"Date\",\n \"dataType\": \"DATE\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-07-02T10:29:38Z\",\n \"updatedDate\": \"2020-07-02T10:29:38Z\",\n \"legacyId\": \"d104a3ad-f87f-4a79-9b3c-1bca5f41a555\"\n },\n {\n \"namespace\": \"emailSubscriptions\",\n \"key\": \"emailSubscriptions.effectiveEmail\",\n \"displayName\": \"Effective Email\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Effective Email for subscription purposes (read only)\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2,\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v4/extended-fields/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"INVALID_SORT"},{"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"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_FILTER_OPERATOR"},{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"UNSUPPORTED_FILTER_VALUE"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CONTACTS_SCHEMA.VIEW"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"protoArtifactId":"com.wixpress.contacts:contacts-fields-app","serviceArtifactId":"com.wixpress.contacts.contacts-fields-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.fields.v4.QueryExtendedFieldsRequest","responseMessage":"com.wixpress.contacts.fields.v4.QueryExtendedFieldsResponse"},"legacyExamples":[{"name":"QueryExtendedFields","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","order":1,"content":{"title":"Query All Extended Fields","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/extended-fields/query' \\\n -H 'Authorization: '","response":"{\n \"fields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.number\",\n \"displayName\": \"number\",\n \"dataType\": \"NUMBER\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2021-01-06T12:57:04Z\",\n \"updatedDate\": \"2021-01-06T12:57:04Z\",\n \"legacyId\": \"5c55ce7e-ca4b-4332-b666-1e00d06e4555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.website\",\n \"displayName\": \"Website\",\n \"dataType\": \"URL\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-07-02T10:29:41Z\",\n \"updatedDate\": \"2020-07-02T10:29:41Z\",\n \"legacyId\": \"0a272857-4d0b-4ce2-bac6-1e3ce4483555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.date\",\n \"displayName\": \"Date\",\n \"dataType\": \"DATE\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-07-02T10:29:38Z\",\n \"updatedDate\": \"2020-07-02T10:29:38Z\",\n \"legacyId\": \"d104a3ad-f87f-4a79-9b3c-1bca5f41a555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.groupcolor\",\n \"displayName\": \"groupColor\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-03-26T10:01:38Z\",\n \"updatedDate\": \"2020-03-26T10:01:38Z\",\n \"legacyId\": \"bb133f4f-67f1-44db-89e8-ea24e471d555\"\n },\n {\n \"namespace\": \"contacts\",\n \"key\": \"contacts.displayByFirstName\",\n \"displayName\": \"Display Name (start with first)\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Display name starting with first name (read only)\"\n },\n {\n \"namespace\": \"contacts\",\n \"key\": \"contacts.displayByLastName\",\n \"displayName\": \"Display Name (start with last)\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Display name starting with last name (read only)\"\n },\n {\n \"namespace\": \"invoices\",\n \"key\": \"invoices.vatId\",\n \"displayName\": \"VAT ID\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Vat ID for Wix Invoices\"\n },\n {\n \"namespace\": \"members\",\n \"key\": \"members.membershipStatus\",\n \"displayName\": \"Membership Status\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"APPROVED/DENIED/PENDING/INACTIVE (read only)\"\n },\n {\n \"namespace\": \"members\",\n \"key\": \"members.mobile\",\n \"displayName\": \"Mobile flag\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"true/false\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.numOfPurchases\",\n \"displayName\": \"# of Purchases\",\n \"dataType\": \"NUMBER\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores purchase count (read only)\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.totalSpentAmount\",\n \"displayName\": \"Total Spent Amount\",\n \"dataType\": \"NUMBER\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores aggregated spent amount (read only)\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.totalSpentCurrency\",\n \"displayName\": \"Total Spent Currency\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores currency code (read only)\"\n },\n {\n \"namespace\": \"ecom\",\n \"key\": \"ecom.lastPurchaseDate\",\n \"displayName\": \"Last Purchase Date\",\n \"dataType\": \"DATE\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Wix Stores last purchase date (read only)\"\n },\n {\n \"namespace\": \"emailSubscriptions\",\n \"key\": \"emailSubscriptions.subscriptionStatus\",\n \"displayName\": \"Effective Subscription Status\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"SUBSCRIBED/UNSUBSCRIBED/NOT_SET/PENDING (read only)\"\n },\n {\n \"namespace\": \"emailSubscriptions\",\n \"key\": \"emailSubscriptions.deliverabilityStatus\",\n \"displayName\": \"Effective Deliverability Status\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"VALID/BOUNCED/SPAM_COMPLAINT/INACTIVE (read only)\"\n },\n {\n \"namespace\": \"emailSubscriptions\",\n \"key\": \"emailSubscriptions.effectiveEmail\",\n \"displayName\": \"Effective Email\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Effective Email for subscription purposes (read only)\"\n }\n ],\n \"metadata\": {\n \"count\": 16,\n \"offset\": 0,\n \"total\": 16,\n }\n}"}},{"name":"QueryExtendedFields","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","order":2,"content":{"title":"Query Extended Fields by Namespace Sorted by CreatedDate Desc","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/extended-fields/query' \\\n -H 'Authorization: '\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"namespace\" : \"custom\"\n },\n \"sort\" : [\n {\"fieldName\": \"createdDate\", \"order\" : \"DESC\"}\n ]\n }\n }'","response":"{\n \"fields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.number\",\n \"displayName\": \"number\",\n \"dataType\": \"NUMBER\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2021-01-06T12:57:04Z\",\n \"updatedDate\": \"2021-01-06T12:57:04Z\",\n \"legacyId\": \"5c55ce7e-ca4b-4332-b666-1e00d06e4555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.website\",\n \"displayName\": \"Website\",\n \"dataType\": \"URL\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-07-02T10:29:41Z\",\n \"updatedDate\": \"2020-07-02T10:29:41Z\",\n \"legacyId\": \"0a272857-4d0b-4ce2-bac6-1e3ce4483555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.date\",\n \"displayName\": \"Date\",\n \"dataType\": \"DATE\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-07-02T10:29:38Z\",\n \"updatedDate\": \"2020-07-02T10:29:38Z\",\n \"legacyId\": \"d104a3ad-f87f-4a79-9b3c-1bca5f41a555\"\n },\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.groupcolor\",\n \"displayName\": \"groupColor\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-03-26T10:01:38Z\",\n \"updatedDate\": \"2020-03-26T10:01:38Z\",\n \"legacyId\": \"bb133f4f-67f1-44db-89e8-ea24e471d555\"\n }\n ],\n \"metadata\": {\n \"count\": 4,\n \"offset\": 0,\n \"total\": 4,\n }\n}"}},{"name":"QueryExtendedFields","serviceName":"ContactExtendedFieldsServiceV4","type":"METHOD","order":3,"content":{"title":"Query Extended Fields by Keys","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/extended-fields/query' \\\n -H 'Authorization: '\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"key\" : {\n \"$in\" : [\"custom.date\", \"emailSubscriptions.effectiveEmail\"]\n }\n }\n }\n }'","response":"{\n \"fields\": [\n {\n \"namespace\": \"custom\",\n \"key\": \"custom.date\",\n \"displayName\": \"Date\",\n \"dataType\": \"DATE\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-07-02T10:29:38Z\",\n \"updatedDate\": \"2020-07-02T10:29:38Z\",\n \"legacyId\": \"d104a3ad-f87f-4a79-9b3c-1bca5f41a555\"\n },\n {\n \"namespace\": \"emailSubscriptions\",\n \"key\": \"emailSubscriptions.effectiveEmail\",\n \"displayName\": \"Effective Email\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"SYSTEM\",\n \"description\": \"Effective Email for subscription purposes (read only)\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2,\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Query Extended Fields","slugifiedName":"query-extended-fields"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"webhooks":[{"summary":"Extended Field Created","title":"Extended Field Created","description":"Triggered when an extended field is created.","permissions":["CONTACTS_SCHEMA.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.contacts.v4.extended-field","serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"eventType":"wix.contacts.v4.extended-field_created","legacyExamples":[{"name":"ExtendedFieldCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"5e0e6a26-eb25-49eb-b5fe-a680d463764e\",\n \"entityFqdn\": \"wix.contacts.v4.extended_field\",\n \"slug\": \"created\",\n \"entityId\": \"custom.example\",\n \"createdEvent\": {\n \"entity\": {\n \"namespace\": \"custom\",\n \"key\": \"custom.example\",\n \"displayName\": \"example\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-10-19T07:33:28.071Z\",\n \"updatedDate\": \"2020-10-19T07:33:28.071Z\",\n \"legacyId\": \"cc17c4fb-07d1-4eb1-a67c-09375bb05595\"\n }\n },\n \"eventTime\": \"2020-10-19T07:33:28.683009Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/crm.git","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField","contentLink":{"displayName":"Extended Field Created","slugifiedName":"extended-field-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Extended Field Updated","title":"Extended Field Updated","description":"Triggered when an extended field is updated.","permissions":["CONTACTS_SCHEMA.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.extended-field","serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"eventType":"wix.contacts.v4.extended-field_updated","legacyExamples":[{"name":"ExtendedFieldUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"bd3df11f-2055-4c1d-b7f2-adcd034f70f1\",\n \"entityFqdn\": \"wix.contacts.v4.extended_field\",\n \"slug\": \"updated\",\n \"entityId\": \"custom.example\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"namespace\": \"custom\",\n \"key\": \"custom.example\",\n \"displayName\": \"example_updated\",\n \"dataType\": \"TEXT\",\n \"fieldType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-10-19T07:33:28Z\",\n \"updatedDate\": \"2020-10-19T07:34:02Z\",\n \"legacyId\": \"cc17c4fb-07d1-4eb1-a67c-09375bb05595\"\n }\n },\n \"eventTime\": \"2020-10-19T07:34:01.880815Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/crm.git","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField","contentLink":{"displayName":"Extended Field Updated","slugifiedName":"extended-field-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Extended Field Deleted","title":"Extended Field Deleted","description":"Triggered when an extended field is deleted.","permissions":["CONTACTS_SCHEMA.VIEW"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.contacts.v4.extended-field","serviceName":"com.wixpress.contacts.fields.v4.ContactExtendedFieldsServiceV4","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"}],"eventType":"wix.contacts.v4.extended-field_deleted","legacyExamples":[{"name":"ExtendedFieldDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"9e75cda3-761b-4a00-8463-5bcf43f74431\",\n \"entityFqdn\": \"wix.contacts.v4.extended_field\",\n \"slug\": \"deleted\",\n \"entityId\": \"custom.example\",\n \"deletedEvent\": {},\n \"eventTime\": \"2020-10-19T07:34:26.593713Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/crm.git","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField","contentLink":{"displayName":"Extended Field Deleted","slugifiedName":"extended-field-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Portfolio","scopeId":"SCOPE.PORTFOLIO.MANAGE-PORTFOLIO"},{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Contact Extended Fields","scopeId":"SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Extended Fields\n\nWhile the Contact List contains the default fields you would expect to find\n(such as name, address, phone, and email)\nadditional information about contacts can be stored in extended fields.\n\nExtended fields can be created by site owners and contributors in the Dashboard,\nor they can be created programmatically by Wix and 3rd-party apps.\nExtended fields store data as text, URL, number, or date.\n\nWhen a new extended field is created, it's available for use for all contacts,\nand it's blank by default.\n\nYou can use the Extended Fields API\nto view and manage extended field definitions.\nTo view and manage data in extended fields for individual contacts,\nyou'll need to use the [Contacts API][contacts-api].\n\nEach extended field is represented in the contact object\nin `info.extendedFields` as key-value pairs.\nEach key is the extended field key,\nand each value is the field's value for the contact.\nEmpty extended fields are not returned.\n\n[contacts-api]: https://dev.wix.com/api/rest/contacts/contacts","sourceRepo":"git@github.com:wix-private/crm.git","path":"proto/appendices/docs/intro.md"},{"displayName":"Sort and Filter","slugifyName":"sort-and-filter","content":"# Extended Fields: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting\nfor the extended field object:\n\n| Field | Supported Filters | Sortable |\n| ------------- | ------------------------------------------ | -------- |\n| `key` | `$eq`, `$ne`, `$in` | |\n| `displayName` | `$eq`, `$ne`, `$in`, `$startsWith` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| `namespace` | `$eq`, `$ne` | |\n| `fieldType` | `$eq` | |\n| `dataType` | `$eq`, `$ne` | |\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 Extended Fields](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::352423a5-a831-4915-bbd1-1fa31993c5cdslug::query-extended-fields*fallback::https://dev.wix.com/api/rest/contacts/extended-fields/query-extended-fields)\n","sourceRepo":"git@github.com:wix-private/crm.git","path":"proto/appendices/docs/sort-and-filter.md"}],"components":{"schemas":{"com.wixpress.contacts.fields.v4.ExtendedField":{"type":"object","properties":{"namespace":{"description":"Extended field namespace.\n\nExtended fields created by site collaborators or 3rd-party apps\nare automatically assigned to the `custom` namespace.","readOnly":true,"minLength":1,"maxLength":25,"title":"namespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"key":{"description":"Extended field key.\n\nWhen accessing contact data,\nextended field data is available at `extendedFields[key]`.\nFor example, if the key is \"custom.notes\",\nthe value can be accessed at `extendedFields[\"custom.notes\"]`.\n\n`key` is generated when the extended field is created\nand cannot be modified, even if `displayName` changes.","readOnly":true,"minLength":1,"maxLength":80,"title":"key","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"displayName":{"description":"Display name shown in the Contact List.","minLength":1,"maxLength":150,"title":"displayName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataType":{"description":"Type of data the field holds.\n\n- `TEXT`: Accepts strings.\n- `NUMBER`: Accepts floats.\n- `DATE`: Accepts dates formatted as `YYYY-MM-DD`.\n- `URL`: Accepts strings. Prepends `https://` if no protocol is included.","readOnly":true,"title":"dataType","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField.FieldDataType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldType":{"description":"Indicates whether the extended field is a system field or custom field.\n\n- `SYSTEM`: The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.\n- `USER_DEFINED`: The field is a custom field and can be modified by 3rd-party apps or site contributors.","readOnly":true,"title":"fieldType","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField.FieldType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the field was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the field was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Field description, if the field is a system field.","readOnly":true,"minLength":1,"maxLength":150,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ExtendedField","description":"Extended field that was found or created."},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"com.wixpress.contacts.fields.v4.ExtendedField.FieldDataType":{"type":"string","description":"","title":"FieldDataType","enum":["UNKNOWN_DATA_TYPE","TEXT","NUMBER","DATE","URL"]},"com.wixpress.contacts.fields.v4.ExtendedField.FieldType":{"type":"string","description":"","title":"FieldType","enum":["UNKNOWN","SYSTEM","USER_DEFINED"]},"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.fields.v4.ListExtendedFieldsRequest":{"type":"object","properties":{"fieldType":{"description":"Filter for fields of the specified type.","title":"fieldType","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField.FieldType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespace":{"description":"Filter for fields in the specified namespace.\nFields created by site contributors or 3rd-party apps\nare automatically assigned to the `custom` namespace.","minLength":3,"maxLength":25,"title":"namespace","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"startsWith":{"description":"Filter for fields where `displayName` starts with the specified case-sensitive string.","maxLength":150,"title":"startsWith","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sorting options.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.upstream.wix.common.Sorting","summary":"sort","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paging":{"description":"Paging options.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListExtendedFieldsRequest","description":"Extended field filter options."},"com.wixpress.contacts.fields.v4.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":100,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order. Use `ASC` for ascending order or `DESC` for descending order.\n\nDefaults to `ASC`.","title":"order","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"com.wixpress.contacts.fields.v4.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"com.wixpress.contacts.fields.v4.upstream.wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to return.\n\nDefaults to `100`.","minimum":0,"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.\n\nDefaults to `0`.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.contacts.fields.v4.ListExtendedFieldsResponse":{"type":"object","properties":{"fields":{"description":"List of extended fields.","title":"fields","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Metadata for the page of results.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.upstream.wix.common.PagingMetadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListExtendedFieldsResponse","description":"List of extended fields."},"com.wixpress.contacts.fields.v4.upstream.wix.common.PagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Requested offset.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Number of items that matched the query.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Indicates if `total` calculation timed out before the response was sent.\nTypically this happens if there is a large set of results.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadata","description":""},"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.fields.v4.FindOrCreateExtendedFieldRequest":{"type":"object","properties":{"displayName":{"description":"Display name to find or create.\n\nIf an existing custom field is an exact match\nfor the specified `displayName`,\nthe existing field is returned.\nIf not, a new field is created and returned.","minLength":1,"maxLength":150,"title":"displayName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dataType":{"description":"Type of data the field holds.\nIgnored if an existing field is an exact match\nfor the specified display name.\n\n- `TEXT`: Accepts strings.\n- `NUMBER`: Accepts floats.\n- `DATE`: Accepts dates formatted as `YYYY-MM-DD`.\n- `URL`: Accepts strings. Prepends `https://` if no protocol is included.","title":"dataType","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField.FieldDataType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FindOrCreateExtendedFieldRequest","description":"Custom field to find or create."},"com.wixpress.contacts.fields.v4.FindOrCreateExtendedFieldResponse":{"type":"object","properties":{"field":{"description":"Extended field that was found or created.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField","summary":"field","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newField":{"description":"Indicates whether the extended field was just created or already existed.\n\nIf the field was just created, returns `true`.\nIf the field already existed, returns `false`.","title":"newField","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FindOrCreateExtendedFieldResponse","description":"Extended field that was found or created."},"com.wixpress.contacts.fields.v4.GetExtendedFieldRequest":{"type":"object","properties":{"key":{"description":"Extended field key.\n\nWhen accessing contact data,\nextended field values are available at `info.extendedFields.items[key]`.\nFor example, if the key is \"custom.patronus\",\nthe value can be accessed at `info.extendedFields.items[\"custom.patronus\"]`.\n\nOnce set, `key` cannot be modified, even if `displayName` changes.","minLength":1,"maxLength":80,"title":"key","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetExtendedFieldRequest","description":""},"com.wixpress.contacts.fields.v4.GetExtendedFieldResponse":{"type":"object","properties":{"field":{"description":"The specified field.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField","summary":"field","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetExtendedFieldResponse","description":"The specified field."},"com.wixpress.contacts.fields.v4.GetExtendedFieldByLegacyIdRequest":{"type":"object","properties":{"legacyId":{"description":"Legacy ID of the extended field.","format":"GUID","title":"legacyId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetExtendedFieldByLegacyIdRequest","description":""},"com.wixpress.contacts.fields.v4.GetExtendedFieldByLegacyIdResponse":{"type":"object","properties":{"field":{"description":"The requested extended field.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField","summary":"field","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetExtendedFieldByLegacyIdResponse","description":""},"com.wixpress.contacts.fields.v4.UpdateExtendedFieldRequest":{"type":"object","properties":{"field":{"description":"Field to update.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField","summary":"field","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateExtendedFieldRequest","description":""},"com.wixpress.contacts.fields.v4.UpdateExtendedFieldResponse":{"type":"object","properties":{"field":{"description":"Updated extended field.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField","summary":"field","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateExtendedFieldResponse","description":"Updated extended field."},"com.wixpress.contacts.fields.v4.DeleteExtendedFieldRequest":{"type":"object","properties":{"key":{"description":"Extended field key.","minLength":1,"maxLength":80,"title":"key","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteExtendedFieldRequest","description":""},"com.wixpress.contacts.fields.v4.DeleteExtendedFieldResponse":{"type":"object","properties":{},"title":"DeleteExtendedFieldResponse","description":""},"com.wixpress.contacts.fields.v4.PurgeRequest":{"type":"object","properties":{"instanceId":{"description":"Instance ID of the site.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PurgeRequest","description":""},"com.wixpress.contacts.fields.v4.PurgeResponse":{"type":"object","properties":{"deletedItems":{"description":"Number of items deleted.","title":"deletedItems","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PurgeResponse","description":""},"com.wixpress.contacts.fields.v4.GdprListRequest":{"type":"object","properties":{"instanceId":{"description":"Instance ID of the site.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GdprListRequest","description":""},"com.wixpress.contacts.fields.v4.GdprListResponse":{"type":"object","properties":{"fields":{"description":"List of extended fields.","title":"fields","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GdprListResponse","description":""},"com.wixpress.contacts.fields.v4.QueryExtendedFieldsRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.upstream.wix.query.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryExtendedFieldsRequest","description":""},"com.wixpress.contacts.fields.v4.upstream.wix.query.Query":{"type":"object","properties":{"filter":{"description":"ilter object.\n\nPossible filters: `$eq`, `$gt`, `$gte`, `$in`, `$lt`, `$lte`, `$ne`, `$startsWith`.\n\nFor a detailed list of supported filters, see [sorting and filtering for extended fields](https://dev.wix.com/api/rest/contacts/extended-fields/sort-and-filter).\n\nExample: `{ \"filter\": {\n\"displayName\": {\n\"$startsWith\": \"Referral\"\n}\n}\n}`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sorting options. Currently supports sorting on one field only.\n\nExample: `{ \"sort\": [{\"fieldName\": \"displayName\", \"order\": \"DESC\"}] }`","maxItems":1,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paging":{"description":"Pagination options.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Query","description":""},"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.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.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.fields.v4.QueryExtendedFieldsResponse":{"type":"object","properties":{"fields":{"description":"List of extended fields.","title":"fields","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.ExtendedField"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/com.wixpress.contacts.fields.v4.upstream.wix.common.PagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryExtendedFieldsResponse","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":"Extended Field","description":"Extended field that was found or created.","fqdn":"wix.contacts.v4.extended_field"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Extended Fields\n\nWhile the Contact List contains the default fields you would expect to find\n(such as name, address, phone, and email)\nadditional information about contacts can be stored in extended fields.\n\nExtended fields can be created by site owners and contributors in the Dashboard,\nor they can be created programmatically by Wix and 3rd-party apps.\nExtended fields store data as text, URL, number, or date.\n\nWhen a new extended field is created, it's available for use for all contacts,\nand it's blank by default.\n\nYou can use the Extended Fields API\nto view and manage extended field definitions.\nTo view and manage data in extended fields for individual contacts,\nyou'll need to use the [Contacts API][contacts-api].\n\nEach extended field is represented in the contact object\nin `info.extendedFields` as key-value pairs.\nEach key is the extended field key,\nand each value is the field's value for the contact.\nEmpty extended fields are not returned.\n\n[contacts-api]: https://dev.wix.com/api/rest/contacts/contacts"},{"displayName":"Sort and Filter","slugifyName":"sort-and-filter","content":"# Extended Fields: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting\nfor the extended field object:\n\n| Field | Supported Filters | Sortable |\n| ------------- | ------------------------------------------ | -------- |\n| `key` | `$eq`, `$ne`, `$in` | |\n| `displayName` | `$eq`, `$ne`, `$in`, `$startsWith` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| `namespace` | `$eq`, `$ne` | |\n| `fieldType` | `$eq` | |\n| `dataType` | `$eq`, `$ne` | |\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 Extended Fields](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::352423a5-a831-4915-bbd1-1fa31993c5cdslug::query-extended-fields*fallback::https://dev.wix.com/api/rest/contacts/extended-fields/query-extended-fields)\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Query Extended Fields

Permission Scopes