POST

Find Or Create Label


Retrieves a label with a specified name, or creates one if it doesn't exist.

Successful calls to this method always return a label, which can be specified in subsequent calls.

For example, in the Contacts API, Label Contact and Unlabel Contact calls will fail if you include a non-existent label. To ensure successful calls, you can call this method first, and then use the response in the Label Contact and Unlabel Contact calls.

To find an existing label without potentially creating a new one, call Get Label or Query Labels.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Members and Contacts - all permissions
Manage Contact Labels
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/contacts/v4/labels

Body Params
displayNamestringRequiredminLength 1maxLength 180

Display name to retrieve or create.

If an existing label is an exact match for the specified display name, the existing label is returned. If not, a new label is created and returned.


languagestringformat LANGUAGE

Language for localization. 2-letter language code in ISO 639-1 alpha-2 format.

Response Object
labelLabel

Label that was found or created.


newLabelboolean

Indicates whether the label was just created or already existed.

Returns true if the label was just created.

Find or Create Label
Request
cURL
curl -X POST 'https://www.wixapis.com/contacts/v4/labels' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ --data-binary '{ "displayName": "My Label" }'
Response
JSON
{ "label": { "namespace": "custom", "key": "custom.my-label", "displayName": "My Label", "labelType": "USER_DEFINED", "createdDate": "2020-04-20T14:02:20Z", "updatedDate": "2020-04-20T14:02:20Z" }, "newLabel": true }
Errors
428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Did this help?