GEgetsitecontrol
Contact fields

Update a contact field

Changes the name of the field and returns it. Only the name changes; the id and the values of contacts stay. Changing the case of the field's own name is allowed.

The name needs at least three latin letters or digits, and the id made from it must fit 100 characters. It must differ, without case, from the names of the other fields of the site, system fields such as "Email" or "First name" included.

patch/v1/sites/{site_id}/contact-fields/{field_id}

Request

  • Base URL
    https://api.getsitecontrol.com
  • Auth
    HTTP bearer

Path parameters

site_idinteger required
field_idstring required

Field id from list_contact_fields

Request body

namestring required

The new name; the id stays

Response

Successful Response

idstring required

Derived from the name on creation; kept on rename

namestring required

Display name

type'text' | 'integer' | 'number' | 'datetime' | 'date' | 'boolean' | 'other' required

text: a string; integer: a whole number; number: a number, decimals allowed; datetime: a moment, ISO 8601 in UTC; date: a day, YYYY-MM-DD; boolean: true or false; other: a field kept from older versions of the admin, read-only on contacts.

created_atstring date-time nullable

Null for fields created before the date was recorded

Changes

No recorded changes to this operation across all 1 revision of this API.