For AI agents: markdown of this page — /docs-content-en/openlines/operator/pause-start.md documentation index — /llms.txt

Start my pause

POST /v1/openlines/operator/pause

Turns on the Open Channel operator pause for the employee the call runs as.

No parameters, no request body. The employee is determined by authorization — see On whose behalf the action runs.

Examples

curl — personal key

Terminal 
curl -X POST https://vibecode.bitrix24.com/v1/openlines/operator/pause \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -X POST https://vibecode.bitrix24.com/v1/openlines/operator/pause \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/openlines/operator/pause', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Pause on:', data.paused)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/openlines/operator/pause', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()
console.log('Pause on:', data.paused)

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue when the pause is turned on
Fielddata.paused Typeboolean DescriptionPause state re-read after the call. true in a successful response

Response example

JSON 
{
  "success": true,
  "data": {
    "paused": true
  }
}

Error response example

401 — the X-Api-Key header is missing:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}

Errors

HTTP Code Description
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the request. The refusal text is in message
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionThe employee the call runs as has no permission for the action
HTTP502 CodeOPENLINE_OPERATOR_FAILED DescriptionThe pause stayed off after the call: the re-read state is false
HTTP502 CodeOPENLINE_OPERATOR_FAILED DescriptionBitrix24 returned a non-boolean value instead of the pause state
HTTP403 CodeSCOPE_DENIED DescriptionThe key has no imopenlines scope
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key is read-only
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeINVALID_API_KEY DescriptionThe key is not recognized
HTTP401 CodeTOKEN_MISSING DescriptionA personal key has no access to the Bitrix24 portal, or an application key was sent without a session token in Authorization
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 is unavailable or the connection to it broke before the response was complete

Full list of common API errors — Errors.

Known specifics

  • Turning the pause on again does not return an error. If the pause is already on, the call returns 200 with paused: true, and the state does not change.

See also