Para agentes de IA: markdown desta página — /docs-content-en/entities/booking-wait-list/update.md índice da documentação — /llms.txt

Os artigos da documentação estão disponíveis atualmente em inglês.

Update an entry

PATCH /v1/booking-wait-list/:id

Changes the note of a wait list record. The wait list is the queue of clients for whom no free time slot was available to book.

Fields go at the root of the JSON, without a fields wrapper.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionRecord identifier. List: GET /v1/booking-wait-list

Request fields (body)

Field Type Required Description
Fieldnote Typestring | null Requiredno DescriptionNew note. An empty string "" removes the note. null or omitting the field keeps the current note

The body accepts no other fields. To change the record's clients, use PUT /v1/booking-wait-list/:id/clients.

Examples

curl — personal key

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/v1/booking-wait-list/27" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"note": "Call back after 16:00"}'

curl — OAuth application

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/v1/booking-wait-list/27" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"note": "Call back after 16:00"}'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/booking-wait-list/27', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ note: 'Call back after 16:00' }),
})

const { data } = await res.json()
console.log(data.note)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/booking-wait-list/27', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ note: 'Call back after 16:00' }),
})

const { data } = await res.json()
console.log(data.note)

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata.id Typenumber DescriptionRecord identifier
Fielddata.note Typestring | null DescriptionNote after the update. null — no note

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 27,
    "note": "Call back after 16:00"
  }
}

Error response example

404 — there is no record with this id:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Booking record not found"
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionThere is no record with this id. Message Booking record not found
HTTP400 CodeINVALID_PARAMS DescriptionThe body contains a field other than note. Message Only note can be written
HTTP400 CodeINVALID_PARAMS Descriptionnote is neither a string nor null. Message note must be a string or null
HTTP400 CodeINVALID_PARAMS DescriptionThe body is not a JSON object, for example an array. Message Body must be an object
HTTP400 CodeINVALID_PARAMS Descriptionid is not a positive integer. Message id must be a canonical positive safe integer
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is not passed
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no Bitrix24 tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe key does not have the booking scope
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key is in read-only mode
HTTP429 CodeRATE_LIMITED DescriptionRequest rate exceeded. The effective cap is in the x-ratelimit-limit header
HTTP502 CodeBITRIX_RESPONSE_INVALID DescriptionBitrix24 did not confirm the update. Message Bitrix24 did not confirm the booking operation
HTTP502 CodeBITRIX_RESPONSE_INVALID DescriptionBitrix24 returned the record in an unexpected shape when it was re-read after the update. The update is already saved — check the record with a get request before retrying

Full list of common API errors — Errors.

See also