Retirer la boîte aux lettres d’un praticien

DELETE/v1/practitioners/{practitioner}/mailbox

Ses fichiers suivants partent par celle de l’OCT.

Droit de clé restreinte : practitioners:write.

Paramètres de chemin

practitionertexteobligatoire
L'identifiant, prac_….

En-têtes

Idempotency-Keytexte
Rend le rejeu de cette écriture sûr pendant 24 heures. Idempotence.

Réponse

Rend le corps ci-contre.

Une erreur suit le format commun.

Requête

curl


curl -X DELETE https://api.ophelix.fr/v1/practitioners/prac_…/mailbox \
  -H "Authorization: Bearer sk_test_…"

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->delete('/v1/practitioners/prac_…/mailbox', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/practitioners/prac_…/mailbox', {
  method: 'DELETE',
  headers: { Authorization: 'Bearer sk_test_…' },
})
const object = await response.json()

Réponse 200


{
  "id": "obj_…",
  "object": "webhook_endpoint",
  "deleted": true
}