Annuler un parcours

PUT https://staging-api.docage.com/Transactions/Abort/cccccccc-0000-4000-8000-000000000003
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…

curl -X PUT "https://staging-api.docage.com/Transactions/Abort/cccccccc-0000-4000-8000-000000000003" \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…"

using HttpClient client = new();
using HttpRequestMessage request = new(HttpMethod.Put, "https://staging-api.docage.com/Transactions/Abort/cccccccc-0000-4000-8000-000000000003");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", token);
using HttpResponseMessage response = await client.SendAsync(request);
string result = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode)
    throw new HttpRequestException(result);

const response = await fetch("https://staging-api.docage.com/Transactions/Abort/cccccccc-0000-4000-8000-000000000003", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${token}`
  }
});
const text = await response.text();
if (!response.ok) throw new Error(text);
const result = text ? JSON.parse(text) : null;

200 : le parcours est annulé (GlobalStatus à 6).

Ce qui se passe

• Les actions qui restaient à faire sont annulées : les liens des participants ne mènent plus à rien, et les codes de signature en attente ne valent plus.
• Les crédits consommés par l'envoi sont rendus, sauf pour un parcours d'essai.
• Un participant ou un observateur n'est prévenu par email que si son NotifyTransactionCancellationByMail est allumé — ce qui n'est pas le cas d'office : sans ce réglage, personne n'est prévenu.

Les refus

• 404 : le parcours est introuvable, ou vous ne le voyez pas.
• 403 : vous le voyez sans avoir le droit de le modifier.
• 400 : l'annulation a échoué ; le message dit pourquoi.

Les pièges

• La route ne regarde pas le statut : un brouillon, ou un parcours déjà terminé, passe aussi « Annulé ». N'annulez qu'un parcours en cours — vérifiez son statut d'abord (Lire le statut d'un parcours).
• L'annulation est définitive : le parcours ne repart pas. Pour recommencer, créez-en un nouveau.
• La version précédente de l'API annulait en GET : cette forme répond désormais 405. Une route qui modifie ne se sert jamais en GET — un lien ouvert, un aperçu de messagerie ou un robot ne déclenche rien.
• Pour clore un parcours sans attendre ses dernières actions, PUT https://staging-api.docage.com/Transactions/Terminate/{id} le déclare terminé et le scelle, même si tous n'ont pas signé : à réserver aux cas où le parcours est réellement conclu hors de Docage.