PATCH

Update Extended Field


Renames an extended field.

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 Extended Fields
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/contacts/v4/extended-fields/{field.key}

Path Params
field.keystringRequired

Extended field key.

When accessing contact data, extended field data is available at extendedFields[key]. For example, if the key is "custom.notes", the value can be accessed at extendedFields["custom.notes"].

key is generated when the extended field is created and can't be modified, even if displayName changes.

Body Params
fieldField

Extended field to rename.

Response Object
fieldField

Renamed extended field.

Update Extended Field
Request
cURL
curl -X PATCH 'https://www.wixapis.com/contacts/v4/extended-fields/custom.my-field' -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ --data-binary '{ "name": "My New Field Name" }'
Response
JSON
{ "namespace": "custom", "key": "custom.my-field", "displayName": "My New Field Name", "dataType": "TEXT", "fieldType": "USER_DEFINED", "createdDate": "2019-10-10T12:30:56Z", "updatedDate": "2020-05-10T07:14:59Z" }
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?