API Docs
Voxbi Cockpit APIs
All endpoints

Update a forward for a user

Replaces the user user forwards specific with the fields supplied in the request body. Fields omitted from the body are reset to their defaults.

HTTP: bearerAuth

User bearer token. Default authentication for customer-facing endpoints. Obtain a token by calling POST /login with your credentials, then send it on every subsequent request as Authorization: Bearer <token>. The token inherits the permissions and PBX scope of the authenticated user.

HTTP Authorization Scheme
bearer
Bearer format
Bearer <token>
user path · string · uuid *
UUID of the user
forward path · string · uuid *
UUID of the forward
accept header · string
example: application/json

Request body · required

Request schema
enabled*boolean
example:
namestring | null
Optional human-readable name used to identify the forward
example: Mobile

Responses

Response schema
dataobject
idstring · uuid
example: 550e8400-e29b-41d4-a716-446655440010
user_idstring · uuid
example: 550e8400-e29b-41d4-a716-446655440001
enabledboolean
eventstring
enum: busy no_answer unconditional unreachable
targetstring
enum: phone_number extension voicemail
target_optionsobject
Free-form object
caller_identity_idstring | null · uuid
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
Data Not Found. This error is returned when the requested data is not found.
Response schema
messagearray<string>
[]string
Unprocessable Parameters. This error is returned when a parameter is not valid.
Response schema
messagestring
example: The given data was invalid.
errorsobject
filterarray<string>
[]string
sortarray<string>
[]string
pagearray<string>
[]string
per_pagearray<string>
[]string
Server error. An unexpected condition was encountered on the server and the request could not be completed. The body is a generic JSON envelope with a `message` field. The response is logged on the server side; quote the request URL + timestamp when reporting an issue.
Response schema
messagestring
exceptionstring
Only present in non-production environments.
filestring
Only present in non-production environments.
lineinteger
Only present in non-production environments.
put https://cockpit.voxbi.com/api/v1/users/{user}/forwards/{forward}
Base URL
Request sample 
curl -X PUT 'https://cockpit.voxbi.com/api/v1/users/{user}/forwards/{forward}' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{"enabled":false,"name":"Mobile"}'
const response = await fetch('https://cockpit.voxbi.com/api/v1/users/{user}/forwards/{forward}', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
  body: JSON.stringify({
    "enabled": false,
    "name": "Mobile"
}),
});

const data = await response.json();
console.log(data);
import requests

response = requests.put('https://cockpit.voxbi.com/api/v1/users/{user}/forwards/{forward}',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'},
    json={
    "enabled": false,
    "name": "Mobile"
}
)
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'PUT',
        'header'  => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
        'content' => '{
    \"enabled\": false,
    \"name\": \"Mobile\"
}',
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/users/{user}/forwards/{forward}', false, $context);
$data = json_decode($response, true);
print_r($data);
Sample request
{ … }
"enabled": false,
"name": "Mobile"
}
{ … }
"data": { … }
"id": "550e8400-e29b-41d4-a716-446655440010",
"user_id": "550e8400-e29b-41d4-a716-446655440001",
"enabled": false,
"event": "no_answer",
"target": "phone_number",
"target_options": { … },
"phone_number": "+12125550100"
},
"caller_identity_id": null
}
}
Host string
example: cockpit.voxbi.com
Date string
example: Mon, 16 Oct 2023 14:08:48 GMT
Connection string
example: close
Cache-Control string
example: no-cache, private
Content-Type string
example: application/json
X-RateLimit-Limit integer
example: 60
X-RateLimit-Remaining integer
example: 59
Vary string
example: Origin
{ … }
"error": "Authorization Token is missing"
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": [ … ]
"Data not found"
]
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"errors": { … }
"filter": [ … ],
"The filter field must be an array."
],
"sort": [ … ],
"The sort field must be a string."
],
"page": [ … ],
"The page field must be an integer."
],
"per_page": [ … ]
"The per page field must be an integer."
]
}
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"message": "Server Error"
}