Relancer les participants
Renvoyer l'invitation aux participants qui n'ont pas encore agi — tous à la fois, ou un seul — et régler les relances automatiques.
Tous les participants qui ont une action en attente
PUT https://staging-api.docage.com/Transactions/SendReminders/cccccccc-0000-4000-8000-000000000003
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…curl -X PUT "https://staging-api.docage.com/Transactions/SendReminders/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/SendReminders/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/SendReminders/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 : chaque participant qui a une action à faire ou commencée — signer, valider, remplir… — reçoit un email de rappel, avec son
lien. Ceux qui ont tout fait, et ceux dont le tour n'est pas venu, ne reçoivent rien.
Un seul participant
PUT https://staging-api.docage.com/TransactionMembers/SendReminder/dddddddd-0000-4000-8000-000000000004
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…curl -X PUT "https://staging-api.docage.com/TransactionMembers/SendReminder/dddddddd-0000-4000-8000-000000000004" \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…"using HttpClient client = new();
using HttpRequestMessage request = new(HttpMethod.Put, "https://staging-api.docage.com/TransactionMembers/SendReminder/dddddddd-0000-4000-8000-000000000004");
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/TransactionMembers/SendReminder/dddddddd-0000-4000-8000-000000000004", {
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 participant reçoit un rappel de sa prochaine action. 400 « Il n'y a pas d'action à rappeler pour ce participant » s'il a
tout fait, ou si son tour n'est pas venu.
Les refus
| Code | Ce qu'il dit |
|---|---|
400 |
« Le parcours n'est pas actif » : il est en brouillon, terminé, refusé, expiré ou annulé. Pour un seul participant, le même cas se dit « Le parcours est introuvable ». |
400 |
Un rappel n'a pas pu partir : le message nomme le participant et la cause. |
403 |
Vous voyez le parcours sans avoir le droit de le modifier. |
404 |
Le parcours — pour un seul participant, le participant — est introuvable, ou vous ne le voyez pas. |
Les relances automatiques
Un parcours relance de lui-même selon ses réglages, posés à sa création — voir Modifier les réglages hérités du modèle :
Reminder:0aucune relance,1chaque jour,2tous les deux jours,7chaque semaine,14toutes les deux semaines,30chaque mois ;MaximumReminders: le nombre de relances, de1à5.
Les pièges
- La version précédente de l'API relançait en
GET: cette forme répond désormais405. - Rien ne limite les relances à la main : relancez avec mesure, chaque appel envoie un email à chacun.
- Le rappel reprend le modèle d'email « Rappel » du parcours : voir Personnaliser l'email d'invitation à signer.