Update custom field configurations

put

https://open-api.guesty.com/v1/accounts/{id}/custom-fields

Replace the account's custom field definitions. The customFields array you send replaces the entire existing set, so any field you omit is removed from the account. Every field must carry a fieldId — new fields cannot be added here — and a field's key, type, object and displayName are fixed at creation and cannot be changed. Returns the account's complete custom field list.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Guesty account ID or me

Body Params

Updates the account's custom fields. The complete set of existing custom fields must be sent in a single request — the fieldId values in the body must match the account's existing field IDs exactly, or the request is rejected with a 400. Only options, isPublic and isRequired are applied; key, type, object and displayName are taken from the stored field and ignored if sent.

customFields

array of objects

IMPORTANT NOTE: every existing custom field must be included, not only the ones you are changing. In practice only options, isPublic and isRequired can be modified — key, type and object are immutable and are read from the stored field.

customFields

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200Custom Fields Array

401Unauthorized

403Forbidden. The token lacks the required custom field permission.

404Not Found. The account does not exist.

500Unhandled exception. Something went wrong on server.