Skip to main content

Update a Custom Field

Update a custom field by ID for a property or reservation.

HTTP Request​

PUT https://dev.calry.app/api/v1/vrs/custom-fields

Headers​

HeaderValue
AuthorizationBearer YOUR_ACCESS_TOKEN
workspaceIdYOUR_WORKSPACE_ID
integrationAccountIdYOUR_INTEGRATION_ACCOUNT_ID

Request Body​

The request body should be a JSON object containing the following fields:

FieldRequiredTypeDescription
customFieldIdYesintegerThe unique identifier for the custom field.
nameNostringName of the custom field.
typeNoCustomFieldTypeType of the custom field.
defaultValueNostringDefault value for the custom field.
defaultValueTypeNostringDefault value type for the custom field.

Custom Field Types: CustomFieldType​

Example Request​

curl --location --request PUT 'https://dev.calry.app/api/v1/vrs/custom-fields' \
--header 'Authorization: Bearer eyJraWQiOiJzLWMwMzE2MzExLTg3NDktNGNhMC05NDg0LTBlNWM1ZDVlMDExOSIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJraWQiOiJzLWJhNjY5YzZhLTE0OTktNDQ1MS05MjFhLTExYzQyNDZhZTQ1NSIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjE2NjI0N2U3LTNiYjktNDExYy05ZDBjLTBjMDY3ZTg0ODhmNCIsIndvcmtzcGFjZUlkIjoiZjAzYzNjOTctNDJjZC00MzMwLTk5OWMtZmM5OTA2ZDgzMzY1IiwibmFtZSI6InNhZGFzIiwic291cmNlIjoibWljcm9zZXJ2aWNlIiwiaWF0IjoxNzA1OTI4ODQ5LCJleHAiOjIyOTA4MTMwMDUxfQ.Vft46kRiDKRXA8u7iOB1USkvECs3bI5qmT0kpU2cpogONrg0HFfoUNj658uBRLoyoUr_tq2TrUqf7S1MGqf58I_1zlpKJ0-7wLlKCA5atWGXDPJqaY6xqsJGwqf3z6Yb1QR7o_r3YsLUizSzHc7BT2wFdHaIBydUyNG_kQEogyFWieMTNFFHwU0aUq1LoSyyIL5nWoDeM-pFd0nd659_HOP1ZlvJIGWjVYB94-IrF1q-i4NKokhx6WEaftuIpSKLEsJAskuDWIzvittcq4RszAvaAVHUOKZd907JASGNpzBF812vggr_HmXVAxdVSo5cmzexh-fcgXfe8npXgkiEhg' \
--header 'workspaceId: 1487796d-3fcd-4a62-884a-3aaba507e732' \
--header 'integrationAccountId: 2462d083-7951-4b67-96c9-a83384d59af3' \
--header 'Content-Type: application/json' \
--data '{
"customFieldId" : 59969,
"name" : "Locker Code",
"type": "text"
}'

Example Response​

{
"success": true,
"data": {
"id": 59969
}
}