Skip to main content

Endpoint & Authentification

En-têtes (Headers) :
  • Authorization: Bearer [VOTRE_JETON_D_API]
  • X-Arquos-Agency: [IDENTIFIANT_D_AGENCE] (facultatif, voir Agence)
  • Content-Type: application/json

Paramètres de la requête

string
L’identifiant de l’agence où agir. Absent : l’agence par défaut du compte. Une agence hors de sa portée est refusée (403).
string
required
Le type de l’objet qui porte la note. Valeurs possibles : equipment, deals, buildings, clients, surveys, suppliers, calls.
string
required
L’identifiant de l’objet.
string
required
Le titre de la note, court.
string
required
Le texte de la note.

Réponse (201)

string
L’identifiant de la note créée.
boolean
Toujours true : un refus rend un code d’erreur et sa raison.
Le chemin de la fiche où la note se lit (celle de l’objet annoté).
string
L’adresse complète de cette fiche.

Les erreurs

Le corps d’une erreur porte error, sa raison en français. Voir Les erreurs.