PATCH

Update Label


Renames a label.

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
PATCH
https://www.wixapis.com/contacts/v4/labels/{label.key}

Path Params
label.keystringRequired

Label key.

key is generated when the label is created. It can't be modified, even if displayName is updated.

Body Params
labelLabel

Label to rename.


languagestringformat LANGUAGE

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

Response Object
labelLabel

Renamed label.

Update Label
Request
cURL
curl -X PATCH 'https://www.wixapis.com/contacts/v4/labels/custom.my-label' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ --data-raw '{ "displayName": "My New Label Name" }'
Response
JSON
{ "label": { "namespace": "custom", "key": "custom.my-label", "displayName": "My New Label Name", "labelType": "USER_DEFINED", "createdDate": "2020-04-20T14:02:20Z", "updatedDate": "2020-05-20T14:06:20Z" } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

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