Annuler une demande d’entente préalable

POST/v1/prior-agreements/{agreement}/cancel

Droit de clé restreinte : quotes:write.

Paramètres de chemin

agreementtexteobligatoire
L'identifiant, pag_….

En-têtes

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

Réponse

Rend l’objet ententes préalables.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/prior-agreements/pag_…/cancel \
  -H "Authorization: Bearer sk_test_…"

PHP


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

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/prior-agreements/pag_…/cancel', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…' },
})
const object = await response.json()

Réponse 200


{
  "id": "obj_…",
  "object": "prior_agreement",
  "status": "draft",
  "practitioner": "…",
  "patient": "…",
  "quote": null,
  "lines": [
    {
      "nomenclature": "…",
      "code": "…",
      "quantity": 0,
      "coefficient": "…"
    }
  ],
  "urgent": true,
  "channel": "paper",
  "sent_on": null,
  "response": "favorable",
  "responded_on": null,
  "identifier": null,
  "claim_line_agreement": null,
  "sent_at": null,
  "approved_at": null,
  "refused_at": null,
  "canceled_at": null,
  "livemode": false,
  "created": 1793970000
}