{"id":"84892e12-d357-48e6-8b87-7fbc54fd0d43","createdDate":"2023-07-30T12:42:18.189Z","updatedDate":"2023-07-30T12:42:18.189Z","resourceId":"644f57b7-19f5-4120-a20e-5e61852c6993","api":{"schema":{"object":{"displayName":"Label Object","description":"","slug":"label-object","$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel","legacyExamples":[{"title":"ContactLabel","content":"{\n \"namespace\" : \"custom\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n}"}],"sourceRepo":"git@github.com:wix-private/crm.git"},"methods":[{"summary":"List Labels","description":"Lists all contact labels for a site.","operationId":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.ListLabels","parameters":[{"name":"labelType","in":"query","description":"Filter for labels of the specified type.","required":false,"schema":{"title":"labelType","description":"Filter for labels of the specified type.","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel.LabelType","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"namespace","in":"query","description":"Filter for labels in the specified namespace.","required":false,"schema":{"title":"namespace","description":"Filter for labels in the specified namespace.","minLength":3,"maxLength":25,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"startsWith","in":"query","description":"Filter for labels where `displayName` starts with the specified case-sensitive string.","required":false,"schema":{"title":"startsWith","description":"Filter for labels where `displayName` starts with the specified case-sensitive string.","minLength":1,"maxLength":180,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"sort","in":"query","description":"Sorting options.","required":false,"schema":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.upstream.wix.common.Sorting","summary":"sort","description":"Sorting options.","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"paging","in":"query","description":"Paging options.","required":false,"schema":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.upstream.wix.common.Paging","summary":"paging","description":"Paging options.","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"language","in":"query","description":"Language for localization.","required":false,"schema":{"title":"language","description":"Language for localization.","format":"LANGUAGE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ListLabelsResponse","description":"List of labels."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/labels","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/labels","destinationPath":"/v4/labels","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","errors":[],"exposure":"PUBLIC","permissions":["CONTACTS_LABELS.VIEW"],"externalPermissionScopes":[{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}],"protoArtifactId":"com.wixpress.contacts:contacts-labels-app","serviceArtifactId":"com.wixpress.contacts.contacts-labels-app","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.labels.v4.ListLabelsRequest","responseMessage":"com.wixpress.contacts.labels.v4.ListLabelsResponse"},"legacyExamples":[{"name":"ListLabels","serviceName":"ContactLabelsServiceV4","type":"METHOD","order":2,"content":{"title":"List Labels Created by Site Contributors","request":"curl -X GET 'https://www.wixapis.com/contacts/v4/labels?labelType=USER_DEFINED' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"labels\": [\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.another-label\",\n \"displayName\": \"Another Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}},{"name":"ListLabels","serviceName":"ContactLabelsServiceV4","type":"METHOD","order":1,"content":{"title":"List All Labels","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/labels' \\\n -H 'Authorization: '","response":"{\n \"labels\": [\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.another-label\",\n \"displayName\": \"Another Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"contacts.customers\",\n \"displayName\": \"Customers\",\n \"labelType\": \"SYSTEM\"\n },\n {\n \"namespace\" : \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"contacts.contacted-me\",\n \"displayName\": \"Contacted Me\",\n \"labelType\": \"SYSTEM\"\n }\n ],\n \"metadata\": {\n \"count\": 4,\n \"offset\": 0,\n \"total\": 4\n }\n}"}},{"name":"ListLabels","serviceName":"ContactLabelsServiceV4","type":"METHOD","order":4,"content":{"title":"List Translated Labels","request":"curl -L -X GET 'https://www.wixapis.com/contacts/v4/labels?language=es' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"labels\": [\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"key\": \"custom.another-label\",\n \"displayName\": \"Another Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"contacts\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"key\": \"contacts.customers\",\n \"displayName\": \"Clientes\",\n \"labelType\": \"SYSTEM\"\n },\n {\n \"namespace\" : \"contacts\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"key\": \"contacts.contacted-me\",\n \"displayName\": \"Me contactaron\",\n \"labelType\": \"SYSTEM\"\n }\n ],\n \"metadata\": {\n \"count\": 4,\n \"offset\": 0,\n \"total\": 4\n }\n}"}},{"name":"ListLabels","serviceName":"ContactLabelsServiceV4","type":"METHOD","order":3,"content":{"title":"List Labels That Start with a String","description":"Lists labels whose display names start with the requested string.","request":"curl -X GET 'https://www.wixapis.com/contacts/v4/labels?startsWith=Ano' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"labels\": [\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.another-label\",\n \"displayName\": \"Another Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n }\n ],\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"total\": 1\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"get","path":"/v4/labels","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","errors":[],"exposure":"PUBLIC","permissions":["CONTACTS_LABELS.VIEW"],"externalPermissionScopes":[{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}],"protoArtifactId":"com.wixpress.contacts:contacts-labels-app","serviceArtifactId":"com.wixpress.contacts.contacts-labels-app","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.labels.v4.ListLabelsRequest","responseMessage":"com.wixpress.contacts.labels.v4.ListLabelsResponse"},"legacyExamples":[{"name":"ListLabels","serviceName":"ContactLabelsServiceV4","type":"METHOD","order":2,"content":{"title":"List Labels Created by Site Contributors","request":"curl -X GET 'https://www.wixapis.com/contacts/v4/labels?labelType=USER_DEFINED' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"labels\": [\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.another-label\",\n \"displayName\": \"Another Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}},{"name":"ListLabels","serviceName":"ContactLabelsServiceV4","type":"METHOD","order":1,"content":{"title":"List All Labels","request":"curl -X GET \\\n 'https://www.wixapis.com/contacts/v4/labels' \\\n -H 'Authorization: '","response":"{\n \"labels\": [\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.another-label\",\n \"displayName\": \"Another Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"contacts.customers\",\n \"displayName\": \"Customers\",\n \"labelType\": \"SYSTEM\"\n },\n {\n \"namespace\" : \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"contacts.contacted-me\",\n \"displayName\": \"Contacted Me\",\n \"labelType\": \"SYSTEM\"\n }\n ],\n \"metadata\": {\n \"count\": 4,\n \"offset\": 0,\n \"total\": 4\n }\n}"}},{"name":"ListLabels","serviceName":"ContactLabelsServiceV4","type":"METHOD","order":4,"content":{"title":"List Translated Labels","request":"curl -L -X GET 'https://www.wixapis.com/contacts/v4/labels?language=es' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"labels\": [\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"key\": \"custom.another-label\",\n \"displayName\": \"Another Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"contacts\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"key\": \"contacts.customers\",\n \"displayName\": \"Clientes\",\n \"labelType\": \"SYSTEM\"\n },\n {\n \"namespace\" : \"contacts\",\n \"namespaceDisplayName\": \"Etiquetas\",\n \"key\": \"contacts.contacted-me\",\n \"displayName\": \"Me contactaron\",\n \"labelType\": \"SYSTEM\"\n }\n ],\n \"metadata\": {\n \"count\": 4,\n \"offset\": 0,\n \"total\": 4\n }\n}"}},{"name":"ListLabels","serviceName":"ContactLabelsServiceV4","type":"METHOD","order":3,"content":{"title":"List Labels That Start with a String","description":"Lists labels whose display names start with the requested string.","request":"curl -X GET 'https://www.wixapis.com/contacts/v4/labels?startsWith=Ano' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"labels\": [\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.another-label\",\n \"displayName\": \"Another Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n }\n ],\n \"metadata\": {\n \"count\": 1,\n \"offset\": 0,\n \"total\": 1\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"List Labels","slugifiedName":"list-labels"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"},{"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 Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Find Or Create Label","description":"Retrieves a label with a given name, or creates one if it doesn't exist.\n\nSuccessful calls to this endpoint always return a label,\nwhich can be passed to subsequent requests.\n\nFor example, in the Contacts API,\n[Label Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/label-contact) and\n[Unlabel Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/unlabel-contact)\nrequests will fail if you include a nonexistant label.\nTo ensure successful calls, you can call this endpoint first,\nand then use the response in the label and unlabel requests.\n\nTo find an existing label without potentially creating a new one, use\n[Get Label](https://dev.wix.com/api/rest/contacts/labels/get-label) or\n[List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels).","operationId":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.FindOrCreateLabel","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.FindOrCreateLabelResponse","description":"Label that was found or created."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/labels","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/labels","destinationPath":"/v4/labels","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"FindOrCreateLabelRequest","description":"Label to find or create.","properties":{"displayName":{"title":"displayName","description":"Display name to retrieve or create.\n\nIf an existing label is an exact match\nfor the specified display name,\nthe existing label is returned.\nIf not, a new label is created and returned.","minLength":1,"maxLength":180,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"language":{"title":"language","description":"Language for localization.","format":"LANGUAGE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["displayName"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Label Created","description":"","permissions":["CONTACTS_LABELS.VIEW"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.contacts.v4.label","serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","domainEvent":"CREATED","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"LABELS_QUOTA_REACHED","errorSchemaName":"com.wixpress.contacts.labels.v4.LabelsQuotaReached"}],"exposure":"PUBLIC","permissions":["CONTACTS_LABELS.MODIFY"],"externalPermissionScopes":[{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}],"protoArtifactId":"com.wixpress.contacts:contacts-labels-app","serviceArtifactId":"com.wixpress.contacts.contacts-labels-app","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.labels.v4.FindOrCreateLabelRequest","responseMessage":"com.wixpress.contacts.labels.v4.FindOrCreateLabelResponse"},"legacyExamples":[{"name":"FindOrCreateLabel","serviceName":"ContactLabelsServiceV4","type":"METHOD","content":{"title":"Find or Create Label","request":"curl -X POST 'https://www.wixapis.com/contacts/v4/labels' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{ \"displayName\": \"My Label\" }'","response":"{\n \"label\" : {\n \"namespace\": \"custom\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n \"newLabel\" : true\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v4/labels","rpcOnly":false,"triggeredEvents":[{"title":"Label Created","description":"","permissions":["CONTACTS_LABELS.VIEW"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.contacts.v4.label","serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","domainEvent":"CREATED","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"LABELS_QUOTA_REACHED","errorSchemaName":"com.wixpress.contacts.labels.v4.LabelsQuotaReached"}],"exposure":"PUBLIC","permissions":["CONTACTS_LABELS.MODIFY"],"externalPermissionScopes":[{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}],"protoArtifactId":"com.wixpress.contacts:contacts-labels-app","serviceArtifactId":"com.wixpress.contacts.contacts-labels-app","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.labels.v4.FindOrCreateLabelRequest","responseMessage":"com.wixpress.contacts.labels.v4.FindOrCreateLabelResponse"},"legacyExamples":[{"name":"FindOrCreateLabel","serviceName":"ContactLabelsServiceV4","type":"METHOD","content":{"title":"Find or Create Label","request":"curl -X POST 'https://www.wixapis.com/contacts/v4/labels' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{ \"displayName\": \"My Label\" }'","response":"{\n \"label\" : {\n \"namespace\": \"custom\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n \"newLabel\" : true\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Find Or Create Label","slugifiedName":"find-or-create-label"},"permissionScopes":[{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}]},{"summary":"Get Label","description":"Retrieves a label.","operationId":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.GetLabel","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"key","description":"Label key.\n\n`key` is generated when the label is created\nand cannot be modified, even if `displayName` changes.","x-wix-docs":{"exposure":"PUBLIC"}},{"name":"language","in":"query","description":"Language for localization.","required":false,"schema":{"title":"language","description":"Language for localization.","format":"LANGUAGE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.GetLabelResponse","description":"The specified label."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/labels","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/labels","destinationPath":"/v4/labels","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","errors":[],"exposure":"PUBLIC","permissions":["CONTACTS_LABELS.VIEW"],"externalPermissionScopes":[{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}],"protoArtifactId":"com.wixpress.contacts:contacts-labels-app","serviceArtifactId":"com.wixpress.contacts.contacts-labels-app","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.labels.v4.GetLabelRequest","responseMessage":"com.wixpress.contacts.labels.v4.GetLabelResponse"},"legacyExamples":[{"name":"GetLabel","serviceName":"ContactLabelsServiceV4","type":"METHOD","content":{"title":"Get Label","request":"curl -X GET 'https://www.wixapis.com/contacts/v4/labels/custom.my-label' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"label\": {\n \"namespace\" : \"custom\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"get","path":"/v4/labels/{key}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","errors":[],"exposure":"PUBLIC","permissions":["CONTACTS_LABELS.VIEW"],"externalPermissionScopes":[{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}],"protoArtifactId":"com.wixpress.contacts:contacts-labels-app","serviceArtifactId":"com.wixpress.contacts.contacts-labels-app","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.labels.v4.GetLabelRequest","responseMessage":"com.wixpress.contacts.labels.v4.GetLabelResponse"},"legacyExamples":[{"name":"GetLabel","serviceName":"ContactLabelsServiceV4","type":"METHOD","content":{"title":"Get Label","request":"curl -X GET 'https://www.wixapis.com/contacts/v4/labels/custom.my-label' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{\n \"label\": {\n \"namespace\" : \"custom\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Get Label","slugifiedName":"get-label"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"},{"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 Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Delete Label","description":"Deletes a label from the site and removes it from contacts it applies to.","operationId":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.DeleteLabel","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"key","description":"Label key to delete.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.DeleteLabelResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/labels","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/labels","destinationPath":"/v4/labels","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Label Deleted","description":"","permissions":["CONTACTS_LABELS.VIEW"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.contacts.v4.label","serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","domainEvent":"DELETED","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","errors":[],"exposure":"PUBLIC","permissions":["CONTACTS_LABELS.MODIFY"],"externalPermissionScopes":[{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}],"protoArtifactId":"com.wixpress.contacts:contacts-labels-app","serviceArtifactId":"com.wixpress.contacts.contacts-labels-app","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.labels.v4.DeleteLabelRequest","responseMessage":"com.wixpress.contacts.labels.v4.DeleteLabelResponse"},"legacyExamples":[{"name":"DeleteLabel","serviceName":"ContactLabelsServiceV4","type":"METHOD","content":{"title":"Delete Label","request":"curl -X DELETE 'https://www.wixapis.com/contacts/v4/labels/custom.my-label' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"delete","path":"/v4/labels/{key}","rpcOnly":false,"triggeredEvents":[{"title":"Label Deleted","description":"","permissions":["CONTACTS_LABELS.VIEW"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.contacts.v4.label","serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","domainEvent":"DELETED","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","errors":[],"exposure":"PUBLIC","permissions":["CONTACTS_LABELS.MODIFY"],"externalPermissionScopes":[{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}],"protoArtifactId":"com.wixpress.contacts:contacts-labels-app","serviceArtifactId":"com.wixpress.contacts.contacts-labels-app","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.labels.v4.DeleteLabelRequest","responseMessage":"com.wixpress.contacts.labels.v4.DeleteLabelResponse"},"legacyExamples":[{"name":"DeleteLabel","serviceName":"ContactLabelsServiceV4","type":"METHOD","content":{"title":"Delete Label","request":"curl -X DELETE 'https://www.wixapis.com/contacts/v4/labels/custom.my-label' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Delete Label","slugifiedName":"delete-label"},"permissionScopes":[{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}]},{"summary":"Update Label","description":"Updates a label's specified properties.","operationId":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.UpdateLabel","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"label.key","description":"Label key.\n\n`key` is generated when the label is created\nand cannot be modified, even if `displayName` changes.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.UpdateLabelResponse","description":"Updated label."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/labels","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/labels","destinationPath":"/v4/labels","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateLabelRequest","description":"","properties":{"label":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel","summary":"label","description":"Label details to update.","x-wix-docs":{"exposure":"PUBLIC"}},"language":{"title":"language","description":"Language for localization.","format":"LANGUAGE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["label.key","label.displayName"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Label Updated","description":"","permissions":["CONTACTS_LABELS.VIEW"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.label","serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","domainEvent":"UPDATED","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","errors":[],"exposure":"PUBLIC","permissions":["CONTACTS_LABELS.MODIFY"],"externalPermissionScopes":[{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}],"protoArtifactId":"com.wixpress.contacts:contacts-labels-app","serviceArtifactId":"com.wixpress.contacts.contacts-labels-app","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.labels.v4.UpdateLabelRequest","responseMessage":"com.wixpress.contacts.labels.v4.UpdateLabelResponse"},"legacyExamples":[{"name":"UpdateLabel","serviceName":"ContactLabelsServiceV4","type":"METHOD","content":{"title":"Update Label","request":"curl -X PATCH 'https://www.wixapis.com/contacts/v4/labels/custom.my-label' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-raw '{\n \"displayName\": \"My New Label Name\"\n }'","response":"{\n \"label\": {\n \"namespace\" : \"custom\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My New Label Name\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-05-20T14:06:20Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"patch","path":"/v4/labels/{label.key}","rpcOnly":false,"triggeredEvents":[{"title":"Label Updated","description":"","permissions":["CONTACTS_LABELS.VIEW"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.label","serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","domainEvent":"UPDATED","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","errors":[],"exposure":"PUBLIC","permissions":["CONTACTS_LABELS.MODIFY"],"externalPermissionScopes":[{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}],"protoArtifactId":"com.wixpress.contacts:contacts-labels-app","serviceArtifactId":"com.wixpress.contacts.contacts-labels-app","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.labels.v4.UpdateLabelRequest","responseMessage":"com.wixpress.contacts.labels.v4.UpdateLabelResponse"},"legacyExamples":[{"name":"UpdateLabel","serviceName":"ContactLabelsServiceV4","type":"METHOD","content":{"title":"Update Label","request":"curl -X PATCH 'https://www.wixapis.com/contacts/v4/labels/custom.my-label' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-raw '{\n \"displayName\": \"My New Label Name\"\n }'","response":"{\n \"label\": {\n \"namespace\" : \"custom\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My New Label Name\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-05-20T14:06:20Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Update Label","slugifiedName":"update-label"},"permissionScopes":[{"name":"Manage Members and Contacts - all permissions","scopeId":"SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS"},{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}]},{"summary":"Query Labels","description":"Retrieves a list of contact labels. Up to 1000 labels can be returned per request.\n\nFor a detailed list of supported operations, see [sorting and filtering for labels](https://dev.wix.com/api/rest/contacts/labels/sort-and-filter). To learn how to query labels, see\n[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).","operationId":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.QueryLabels","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.QueryLabelsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/contacts/v4/labels","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/contacts/v4/labels","destinationPath":"/v4/labels","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryLabelsRequest","description":"","properties":{"query":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.upstream.wix.query.Query","summary":"query","description":"Query options.","x-wix-docs":{"exposure":"PUBLIC"}},"language":{"title":"language","description":"Language for localization.","format":"LANGUAGE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","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","permissions":["CONTACTS_LABELS.VIEW"],"externalPermissionScopes":[{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}],"protoArtifactId":"com.wixpress.contacts:contacts-labels-app","serviceArtifactId":"com.wixpress.contacts.contacts-labels-app","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.labels.v4.QueryLabelsRequest","responseMessage":"com.wixpress.contacts.labels.v4.QueryLabelsResponse"},"legacyExamples":[{"name":"QueryLabels","serviceName":"ContactLabelsServiceV4","type":"METHOD","order":3,"content":{"title":"Query Labels by Keys","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/labels/query' \\\n -H 'Authorization: '\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"key\" : {\n \"$in\" : [\"custom.my-label\", \"contacts.contacted-me\"]\n }\n }\n }\n }'","response":"{\n \"labels\": [\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"contacts.contacted-me\",\n \"displayName\": \"Contacted Me\",\n \"labelType\": \"SYSTEM\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}},{"name":"QueryLabels","serviceName":"ContactLabelsServiceV4","type":"METHOD","order":2,"content":{"title":"Query Labels by Namespace Sorted by CreatedDate Desc","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/labels/query' \\\n -H 'Authorization: '\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"namespace\" : \"custom\"\n },\n \"sort\" :\n [\n {\"fieldName\": \"createdDate\", \"order\" : \"DESC\"}\n ]\n }\n }'","response":"{\n \"labels\": [\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.another-label\",\n \"displayName\": \"Another Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2021-04-20T14:02:20Z\",\n \"updatedDate\": \"2021-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}},{"name":"QueryLabels","serviceName":"ContactLabelsServiceV4","type":"METHOD","order":1,"content":{"title":"Query All Labels","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/labels/query' \\\n -H 'Authorization: '","response":"{\n \"labels\": [\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.another-label\",\n \"displayName\": \"Another Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2021-04-20T14:02:20Z\",\n \"updatedDate\": \"2021-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"contacts.customers\",\n \"displayName\": \"Customers\",\n \"labelType\": \"SYSTEM\"\n },\n {\n \"namespace\" : \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"contacts.contacted-me\",\n \"displayName\": \"Contacted Me\",\n \"labelType\": \"SYSTEM\"\n }\n ],\n \"metadata\": {\n \"count\": 4,\n \"offset\": 0,\n \"total\": 4\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v4/labels/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","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","permissions":["CONTACTS_LABELS.VIEW"],"externalPermissionScopes":[{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"}],"protoArtifactId":"com.wixpress.contacts:contacts-labels-app","serviceArtifactId":"com.wixpress.contacts.contacts-labels-app","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.contacts.labels.v4.QueryLabelsRequest","responseMessage":"com.wixpress.contacts.labels.v4.QueryLabelsResponse"},"legacyExamples":[{"name":"QueryLabels","serviceName":"ContactLabelsServiceV4","type":"METHOD","order":3,"content":{"title":"Query Labels by Keys","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/labels/query' \\\n -H 'Authorization: '\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"key\" : {\n \"$in\" : [\"custom.my-label\", \"contacts.contacted-me\"]\n }\n }\n }\n }'","response":"{\n \"labels\": [\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"contacts.contacted-me\",\n \"displayName\": \"Contacted Me\",\n \"labelType\": \"SYSTEM\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}},{"name":"QueryLabels","serviceName":"ContactLabelsServiceV4","type":"METHOD","order":2,"content":{"title":"Query Labels by Namespace Sorted by CreatedDate Desc","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/labels/query' \\\n -H 'Authorization: '\n --data-binary '{\n \"query\": {\n \"filter\": {\n \"namespace\" : \"custom\"\n },\n \"sort\" :\n [\n {\"fieldName\": \"createdDate\", \"order\" : \"DESC\"}\n ]\n }\n }'","response":"{\n \"labels\": [\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.another-label\",\n \"displayName\": \"Another Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2021-04-20T14:02:20Z\",\n \"updatedDate\": \"2021-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n }\n ],\n \"metadata\": {\n \"count\": 2,\n \"offset\": 0,\n \"total\": 2\n }\n}"}},{"name":"QueryLabels","serviceName":"ContactLabelsServiceV4","type":"METHOD","order":1,"content":{"title":"Query All Labels","request":"curl -X POST \\\n 'https://www.wixapis.com/contacts/v4/labels/query' \\\n -H 'Authorization: '","response":"{\n \"labels\": [\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.my-label\",\n \"displayName\": \"My Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2020-04-20T14:02:20Z\",\n \"updatedDate\": \"2020-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"custom\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"custom.another-label\",\n \"displayName\": \"Another Label\",\n \"labelType\": \"USER_DEFINED\",\n \"createdDate\": \"2021-04-20T14:02:20Z\",\n \"updatedDate\": \"2021-04-20T14:02:20Z\"\n },\n {\n \"namespace\" : \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"contacts.customers\",\n \"displayName\": \"Customers\",\n \"labelType\": \"SYSTEM\"\n },\n {\n \"namespace\" : \"contacts\",\n \"namespaceDisplayName\": \"Labels\",\n \"key\": \"contacts.contacted-me\",\n \"displayName\": \"Contacted Me\",\n \"labelType\": \"SYSTEM\"\n }\n ],\n \"metadata\": {\n \"count\": 4,\n \"offset\": 0,\n \"total\": 4\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Query Labels","slugifiedName":"query-labels"},"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"},{"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 Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"webhooks":[{"summary":"Contact Label Created","title":"Label Created","description":"","permissions":["CONTACTS_LABELS.VIEW"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.contacts.v4.label","serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","domainEvent":"CREATED","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/crm.git","$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel","contentLink":{"displayName":"Contact Label Created","slugifiedName":"contact-label-created"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"},{"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 Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Contact Label Updated","title":"Label Updated","description":"","permissions":["CONTACTS_LABELS.VIEW"],"exposure":"PUBLIC","maturity":"BETA","slug":"updated","eventTopic":"domain_events_wix.contacts.v4.label","serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","domainEvent":"UPDATED","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/crm.git","$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel","contentLink":{"displayName":"Contact Label Updated","slugifiedName":"contact-label-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"},{"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 Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Contact Label Deleted","title":"Label Deleted","description":"","permissions":["CONTACTS_LABELS.VIEW"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.contacts.v4.label","serviceName":"com.wixpress.contacts.labels.v4.ContactLabelsServiceV4","domainEvent":"DELETED","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/crm.git","$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel","contentLink":{"displayName":"Contact Label Deleted","slugifiedName":"contact-label-deleted"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Bookings Services and Settings","scopeId":"SCOPE.BOOKINGS.CONFIGURATION"},{"name":"Manage Contact Labels","scopeId":"SCOPE.DC-CONTACTS.MANAGE-LABELS"},{"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 Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Labels\n\nLabels allow site contributors to segment contacts in their Contact List.\nContact labels are useful for targeting specific audiences\nfor email campaigns or bulk actions.\n\nWith the label APIs, your app can view and manage a site's labels.\nThe responses can be used to [query contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts)\nin subsequent API requests.\n\nFor more information on how labels are used,\nsee these Wix Help Center articles:\n\n- [Adding Labels to Contacts in Your Contact List](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)\n- [Predefined Contact Labels](https://support.wix.com/en/article/predefined-contact-labels)\n- [Creating Contact Labels](https://support.wix.com/en/article/creating-contact-labels)\n","sourceRepo":"git@github.com:wix-private/crm.git","path":"proto/docs/intro.md"},{"displayName":"Sort and Filter","slugifyName":"sort-and-filter","content":"# Contact Labels: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting\nfor the label 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| `labelType` | `$eq` | |\n\n__Related content:__\n[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Labels](https://dev.wix.com/api/rest/contacts/labels/query-labels)\n","sourceRepo":"git@github.com:wix-private/crm.git","path":"proto/docs/sort-and-filter.md"}],"components":{"schemas":{"com.wixpress.contacts.labels.v4.ContactLabel":{"type":"object","properties":{"namespace":{"title":"namespace","description":"Label namespace.\n\nLabels created by site contributors or 3rd-party apps\nare automatically assigned to the `custom` namespace.","readOnly":true,"minLength":1,"maxLength":25,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"namespaceDisplayName":{"title":"namespaceDisplayName","description":"Display name for the namespace,\nused to organize the list of labels in the site Dashboard.","readOnly":true,"minLength":1,"maxLength":180,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"key":{"title":"key","description":"Label key.\n\n`key` is generated when the label is created\nand cannot be modified, even if `displayName` changes.","readOnly":true,"minLength":1,"maxLength":80,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"displayName":{"title":"displayName","description":"Label display name shown in the Dashboard.","minLength":1,"maxLength":180,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"labelType":{"title":"labelType","description":"Label type.\n\n- `SYSTEM`: The label is a default system label for the Contact List.\n- `USER_DEFINED`: The label was created by a site contributor or 3rd-party app.\n- `WIX_APP_DEFINED`: The label was created by a Wix app.","readOnly":true,"type":"string","$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel.LabelType","x-wix-docs":{"exposure":"PUBLIC"}},"createdDate":{"title":"createdDate","description":"Date and time the label was created.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"updatedDate":{"title":"updatedDate","description":"Date and time the label was last updated.","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ContactLabel","description":"Label that was found or created."},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"com.wixpress.contacts.labels.v4.ContactLabel.LabelType":{"type":"string","description":"","title":"LabelType","enum":["UNKNOWN","SYSTEM","USER_DEFINED","WIX_APP_DEFINED"]},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"title":"seconds","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"title":"nanos","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"com.wixpress.contacts.labels.v4.ListLabelsRequest":{"type":"object","properties":{"labelType":{"title":"labelType","description":"Filter for labels of the specified type.","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel.LabelType","x-wix-docs":{"exposure":"PUBLIC"}},"namespace":{"title":"namespace","description":"Filter for labels in the specified namespace.","minLength":3,"maxLength":25,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"startsWith":{"title":"startsWith","description":"Filter for labels where `displayName` starts with the specified case-sensitive string.","minLength":1,"maxLength":180,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.upstream.wix.common.Sorting","summary":"sort","description":"Sorting options.","x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.upstream.wix.common.Paging","summary":"paging","description":"Paging options.","x-wix-docs":{"exposure":"PUBLIC"}},"language":{"title":"language","description":"Language for localization.","format":"LANGUAGE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListLabelsRequest","description":"Label filter options."},"com.wixpress.contacts.labels.v4.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"title":"fieldName","description":"Name of the field to sort by.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"order":{"title":"order","description":"Sort order. Use `ASC` for ascending order or `DESC` for descending order.\n\nDefaults to `ASC`.","type":"string","$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Sorting","description":""},"com.wixpress.contacts.labels.v4.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"com.wixpress.contacts.labels.v4.upstream.wix.common.Paging":{"type":"object","properties":{"limit":{"title":"limit","description":"Number of items to return.\n\nDefaults to `1000`.
\nMaximum: `2000`.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Number of items to skip in the current sort order.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Paging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int32Value","description":""},"com.wixpress.contacts.labels.v4.ListLabelsResponse":{"type":"object","properties":{"labels":{"title":"labels","description":"List of labels.","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel"},"x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.upstream.wix.common.PagingMetadata","summary":"metadata","description":"Metadata for the page of results.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListLabelsResponse","description":"List of labels."},"com.wixpress.contacts.labels.v4.upstream.wix.common.PagingMetadata":{"type":"object","properties":{"count":{"title":"count","description":"Number of items returned.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Requested offset.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"total":{"title":"total","description":"Number of items that matched the query.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"tooManyToCount":{"title":"tooManyToCount","description":"Indicates if `total` calculation timed out before the response was sent.\nTypically this happens if there is a large set of results.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PagingMetadata","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"com.wixpress.contacts.labels.v4.FindOrCreateLabelRequest":{"type":"object","properties":{"displayName":{"title":"displayName","description":"Display name to retrieve or create.\n\nIf an existing label is an exact match\nfor the specified display name,\nthe existing label is returned.\nIf not, a new label is created and returned.","minLength":1,"maxLength":180,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"language":{"title":"language","description":"Language for localization.","format":"LANGUAGE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FindOrCreateLabelRequest","description":"Label to find or create."},"com.wixpress.contacts.labels.v4.FindOrCreateLabelResponse":{"type":"object","properties":{"label":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel","summary":"label","description":"Label that was found or created.","x-wix-docs":{"exposure":"PUBLIC"}},"newLabel":{"title":"newLabel","description":"Indicates whether the label was just created or already existed.\n\nIf the label was just created, returns `true`.\nIf it already existed, returns `false`.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FindOrCreateLabelResponse","description":"Label that was found or created."},"com.wixpress.contacts.labels.v4.LabelsQuotaReached":{"type":"object","properties":{"labelsQuota":{"title":"labelsQuota","description":"","$ref":"#/components/schemas/google.protobuf.Int64Value","x-wix-docs":{"exposure":"PUBLIC"}},"labelsCurrentTotal":{"title":"labelsCurrentTotal","description":"","$ref":"#/components/schemas/google.protobuf.Int64Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"LabelsQuotaReached","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int64Value","description":""},"com.wixpress.contacts.labels.v4.ListLabelNamespacesRequest":{"type":"object","properties":{"language":{"title":"language","description":"Language for localization","format":"LANGUAGE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListLabelNamespacesRequest","description":""},"com.wixpress.contacts.labels.v4.ListLabelNamespacesResponse":{"type":"object","properties":{"namespaces":{"title":"namespaces","description":"","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabelNamespace"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListLabelNamespacesResponse","description":""},"com.wixpress.contacts.labels.v4.ContactLabelNamespace":{"type":"object","properties":{"key":{"title":"key","description":"Namespace key","readOnly":true,"minLength":1,"maxLength":25,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"displayName":{"title":"displayName","description":"Namespace display name","readOnly":true,"minLength":1,"maxLength":25,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ContactLabelNamespace","description":""},"com.wixpress.contacts.labels.v4.GetLabelRequest":{"type":"object","properties":{"key":{"title":"key","description":"Label key.\n\n`key` is generated when the label is created\nand cannot be modified, even if `displayName` changes.","minLength":1,"maxLength":80,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"language":{"title":"language","description":"Language for localization.","format":"LANGUAGE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetLabelRequest","description":""},"com.wixpress.contacts.labels.v4.GetLabelResponse":{"type":"object","properties":{"label":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel","summary":"label","description":"The specified label.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetLabelResponse","description":"The specified label."},"com.wixpress.contacts.labels.v4.GetLabelByLegacyIdRequest":{"type":"object","properties":{"legacyId":{"title":"legacyId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"language":{"title":"language","description":"Language for localization","format":"LANGUAGE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetLabelByLegacyIdRequest","description":""},"com.wixpress.contacts.labels.v4.GetLabelByLegacyIdResponse":{"type":"object","properties":{"label":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel","summary":"label","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetLabelByLegacyIdResponse","description":""},"com.wixpress.contacts.labels.v4.UpdateLabelRequest":{"type":"object","properties":{"label":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel","summary":"label","description":"Label details to update.","x-wix-docs":{"exposure":"PUBLIC"}},"language":{"title":"language","description":"Language for localization.","format":"LANGUAGE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateLabelRequest","description":""},"com.wixpress.contacts.labels.v4.UpdateLabelResponse":{"type":"object","properties":{"label":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel","summary":"label","description":"Updated label.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateLabelResponse","description":"Updated label."},"com.wixpress.contacts.labels.v4.DeleteLabelRequest":{"type":"object","properties":{"key":{"title":"key","description":"Label key to delete.","minLength":1,"maxLength":80,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeleteLabelRequest","description":""},"com.wixpress.contacts.labels.v4.DeleteLabelResponse":{"type":"object","properties":{},"title":"DeleteLabelResponse","description":""},"com.wixpress.contacts.labels.v4.PurgeRequest":{"type":"object","properties":{"instanceId":{"title":"instanceId","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"exludingLabelKeys":{"title":"exludingLabelKeys","description":"","maxLength":80,"maxItems":80,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PurgeRequest","description":""},"com.wixpress.contacts.labels.v4.PurgeResponse":{"type":"object","properties":{"deletedItems":{"title":"deletedItems","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PurgeResponse","description":""},"com.wixpress.contacts.labels.v4.GdprListRequest":{"type":"object","properties":{"instanceId":{"title":"instanceId","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GdprListRequest","description":""},"com.wixpress.contacts.labels.v4.GdprListResponse":{"type":"object","properties":{"labels":{"title":"labels","description":"","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GdprListResponse","description":""},"com.wixpress.contacts.labels.v4.QueryLabelsRequest":{"type":"object","properties":{"query":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.upstream.wix.query.Query","summary":"query","description":"Query options.","x-wix-docs":{"exposure":"PUBLIC"}},"language":{"title":"language","description":"Language for localization.","format":"LANGUAGE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryLabelsRequest","description":""},"com.wixpress.contacts.labels.v4.upstream.wix.query.Query":{"type":"object","properties":{"filter":{"title":"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 labels](https://dev.wix.com/api/rest/contacts/labels/sort-and-filter).\n\nExample: `{ \"filter\": {\n\"displayName\": {\n\"$startsWith\": \"Referral\"\n}\n}\n}`","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"title":"sort","description":"Sorting options. For a list of fields that can be sorted, see [sorting and filtering for labels](https://dev.wix.com/api/rest/contacts/labels/sort-and-filter).\n\nExample: `{ \"sort\": [{\"fieldName\": \"displayName\", \"order\": \"DESC\"}] }`","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.upstream.wix.common.Paging","summary":"paging","description":"Pagination options.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Query","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"title":"fields","description":"","type":"object","format":"map","properties":{"key:value":{"type":"object","description":"\"key\" of type string, \"value\" of type object","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"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":{"title":"nullValue","description":"","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC"}},"numberValue":{"title":"numberValue","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"stringValue":{"title":"stringValue","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"boolValue":{"title":"boolValue","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"structValue":{"title":"structValue","description":"","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"listValue":{"title":"listValue","description":"","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"title":"values","description":"","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListValue","description":""},"com.wixpress.contacts.labels.v4.QueryLabelsResponse":{"type":"object","properties":{"labels":{"title":"labels","description":"List of labels","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.ContactLabel"},"x-wix-docs":{"exposure":"PUBLIC"}},"pagingMetadata":{"$ref":"#/components/schemas/com.wixpress.contacts.labels.v4.upstream.wix.common.PagingMetadata","summary":"pagingMetadata","description":"Details on the paged set of results returned.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryLabelsResponse","description":""}}},"title":"Label","description":"","fqdn":"wix.contacts.v4.label"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# Labels\n\nLabels allow site contributors to segment contacts in their Contact List.\nContact labels are useful for targeting specific audiences\nfor email campaigns or bulk actions.\n\nWith the label APIs, your app can view and manage a site's labels.\nThe responses can be used to [query contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts)\nin subsequent API requests.\n\nFor more information on how labels are used,\nsee these Wix Help Center articles:\n\n- [Adding Labels to Contacts in Your Contact List](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)\n- [Predefined Contact Labels](https://support.wix.com/en/article/predefined-contact-labels)\n- [Creating Contact Labels](https://support.wix.com/en/article/creating-contact-labels)\n"},{"displayName":"Sort and Filter","slugifyName":"sort-and-filter","content":"# Contact Labels: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting\nfor the label 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| `labelType` | `$eq` | |\n\n__Related content:__\n[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Labels](https://dev.wix.com/api/rest/contacts/labels/query-labels)\n"}]},"reviewStatus":"APPROVED","isLocked":true}

Get Label

Permission Scopes