Annuler un code d’appairage

POST/v1/workstation-pairing-codes/{code}/cancel

Droit de clé restreinte : workstations:write.

Paramètres de chemin

codetexteobligatoire
L'identifiant, wpc_….

En-têtes

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

Réponse

Rend l’objet codes d’appairage.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/workstation-pairing-codes/wpc_…/cancel \
  -H "Authorization: Bearer sk_test_…"

PHP


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

TypeScript


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

Réponse 200


{
  "id": "wpc_034t7hCZcEgoE0r0ABaKuL",
  "object": "workstation_pairing_code",
  "status": "cancelled",
  "stage": null,
  "previewed_at": null,
  "agent": null,
  "current_organization": null,
  "expires_at": 1794005296,
  "workstation": null,
  "created": 1794004696,
  "livemode": false
}