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

Starts the pause and returns the re-read state.

Scope: imopenlines. A write-enabled key is required.

For a webhook key this is the pause of the employee who issued the webhook. For OAuth it is the calling employee. No user parameter is accepted.

Examples

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/openlines/operator/pause" \
  -H "X-Api-Key: YOUR_API_KEY"
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 
const response = await fetch('https://vibecode.bitrix24.com/v1/openlines/operator/pause', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
});
const result = await response.json();
if (!response.ok) throw new Error(result.error.message);
console.log(result.data);
javascript 
const response = 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 result = await response.json();
if (!response.ok) throw new Error(result.error.message);
console.log(result.data);

Response fields

Field Type Description
success boolean true
data object Operation result
data.paused boolean Current pause state

Response example

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

Error response example

403: the calling employee has no access.

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "Access denied"
  }
}

Errors

HTTP Code Condition
403 SCOPE_DENIED Missing imopenlines scope
403 BITRIX_ACCESS_DENIED No access in Bitrix24
403 WRITE_BLOCKED_READONLY_KEY Key forbids writes
422 BITRIX_ERROR Business refusal; message is preserved
502 OPENLINE_OPERATOR_FAILED Unexpected result or unapplied pause state

System errors.

Known details

Repeated pause writes return the current state, even when the state was already set.

See also