Créer le parcours
Créer un parcours vide, en brouillon, et en régler le nom, la durée de validité et les relances.
POST https://staging-api.docage.com/Transactions
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…
Content-Type: application/json
{
"Name": "Contrat avec Atelier Lumière",
"DaysBeforeEnding": 15,
"Reminder": 2,
"MaximumReminders": 3
}curl -X POST "https://staging-api.docage.com/Transactions" \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…" \
-H "Content-Type: application/json" \
-d '{
"Name": "Contrat avec Atelier Lumière",
"DaysBeforeEnding": 15,
"Reminder": 2,
"MaximumReminders": 3
}'using HttpClient client = new();
using HttpRequestMessage request = new(HttpMethod.Post, "https://staging-api.docage.com/Transactions");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", token);
request.Content = new StringContent("""
{
"Name": "Contrat avec Atelier Lumière",
"DaysBeforeEnding": 15,
"Reminder": 2,
"MaximumReminders": 3
}
""", Encoding.UTF8, "application/json");
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", {
method: "POST",
headers: {
Authorization: `Bearer ${token}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"Name": "Contrat avec Atelier Lumière",
"DaysBeforeEnding": 15,
"Reminder": 2,
"MaximumReminders": 3
})
});
const text = await response.text();
if (!response.ok) throw new Error(text);
const result = text ? JSON.parse(text) : null;La réponse est l'identifiant du parcours, en chaîne JSON :
"cccccccc-0000-4000-8000-000000000003"Le parcours est un brouillon (GlobalStatus à 0) : personne n'est invité tant qu'il n'est pas lancé.
Les réglages
| Propriété | Ce qu'elle règle |
|---|---|
Name |
Le nom du parcours, 255 caractères au plus. |
DaysBeforeEnding |
Sa durée de validité, en jours, de 1 à 30 (30 d'office), comptée depuis l'envoi ; EndDate (UTC) la fixe à la place. |
Reminder |
Ses relances automatiques : 0 aucune, 1 chaque jour, 2 tous les deux jours, 7 chaque semaine, 14 toutes les deux semaines, 30 chaque mois. |
MaximumReminders |
Le nombre de relances automatiques, de 1 à 5. |
IsTest |
true : un parcours d'essai, sans consommation de crédits, aux documents filigranés. |
ExternalId |
Votre référence, 128 caractères au plus. |
CustomFieldsUserData |
Les valeurs de ses champs personnalisés — voir Champs personnalisés. |
Une valeur hors bornes répond 400, avec le détail par propriété.
Les pièges
TemplateIdest accepté ici, mais n'y copie rien du modèle : pour partir d'un modèle, voir Créer un parcours à partir d'un modèle.GlobalStatuset les statuts sont tenus par le serveur : ceux que vous envoyez sont ignorés.- Une organisation qui n'est pas encore en production crée des parcours d'essai, quel que soit
IsTest. - Suite : Ajouter un document.