Vérifier la boîte aux lettres d’un praticien

POST/v1/practitioners/{practitioner}/mailbox/verify

Ouvre une session d’envoi et une session de relevé, sans rien envoyer ni effacer. Le résultat se lit dans verified_at ou last_error_code.

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 l’objet boîtes aux lettres.

Une erreur suit le format commun.

Requête

curl


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

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/practitioners/prac_…/mailbox/verify', [
    '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/verify', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…' },
})
const object = await response.json()

Réponse 200


{
  "id": "obj_…",
  "object": "mailbox",
  "practitioner": null,
  "address": "…",
  "username": "…",
  "smtp": {
    "host": "…",
    "port": 0,
    "security": "tls"
  },
  "retrieval": {
    "protocol": "imap",
    "host": "…",
    "port": 0,
    "security": "tls"
  },
  "verified_at": null,
  "last_fetched_at": null,
  "last_error_code": null,
  "last_error_at": null,
  "set_aside_count": 0,
  "livemode": false,
  "created": 1793970000
}