Skip to content

Remove a user's profile picture

Removes the profile picture of the user in the path. Its public link stops working and profile_picture_url becomes null. Succeeds also when there was no picture. A customer API key needs the user-profile-pictures scope; a user token can only target its own id.

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>
HTTP: IntegrationApiKey

API key created on the Cockpit Integrations page (an "API key" integration). It is a bearer token owned by the customer's PBX and limited to the scopes selected when the key was created (e.g. phone-numbers, push-configuration).

Send it in the Authorization header:

Authorization: Bearer <api_key>

Manage keys (create / reveal / revoke) from Integrations → New integration → API key.

HTTP Authorization Scheme
bearer
user path · string · uuid *
The user's id. A user of another PBX answers 404.
accept header · string
example: application/json

Responses

Removed (or there was nothing to remove).
Response schema
messagestring
dataobject
profile_picture_urlnull
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
The API key lacks the `user-profile-pictures` scope, or a user token targets another user.
Response schema
messagestring
No such user in the caller's PBX (a user of another PBX answers the same).
Response schema
messagestring
The picture is synced from Microsoft 365 and cannot be changed in Cockpit while the PBX syncs pictures. Change it in Microsoft 365.
Response schema
messagestring
dataobject
profile_picture_urlstring · uri
Too many uploads or removals (10 per minute per caller).
Response schema
messagestring
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.
delete https://cockpit.voxbi.com/api/v1/users/{user}/profile-picture
Base URL
Request sample
curl -X DELETE 'https://cockpit.voxbi.com/api/v1/users/{user}/profile-picture' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/users/{user}/profile-picture', {
  method: 'DELETE',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${YOUR_TOKEN}`,
  },
});

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

response = requests.delete('https://cockpit.voxbi.com/api/v1/users/{user}/profile-picture',
    headers={'Authorization': f'Bearer {YOUR_TOKEN}'}
)
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'DELETE',
        'header'  => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/users/{user}/profile-picture', false, $context);
$data = json_decode($response, true);
print_r($data);
{ … }
"message": "Profile picture removed.",
"data": { … }
"profile_picture_url": null
}
}
{ … }
"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": "Invalid ability provided."
}
{ … }
"message": "No such user in your PBX."
}
{ … }
"message": "This profile picture is synced from Microsoft 365. Change it in Microsoft 365.",
"data": { … }
"profile_picture_url": "https://cockpit.voxbi.com/avatar/k3Pq9ZtLm2Xw8nBv7pRa"
}
}
{ … }
"message": "Too Many Attempts."
}
{ … }
"message": "Server Error"
}