Passer au contenu principal
POST

Autorisations

Authorization
string
header
requis

Token LinkedAPI avec scope externalIntegration. La clé doit avoir un agencyGroup configuré (sinon 400 LinkedAPI agencyGroup is required). Fourni via l'en-tête Authorization: Bearer {linkedAPI_token}. Si la clé a secure === true, l'IP appelante doit être whitelistée (en-tête X-Real-IP), sinon 403 Not authorized to access this resource.

La clé porte aussi un niveau d'accès : en lecture seule, elle n'autorise que les GET ; un POST ou un PATCH renvoie alors 403 Not authorized to access this resource, soit la même réponse qu'une requête sans en-tête Authorization. Voir le guide Authentification.

Corps

application/json
document
string
requis

ObjectId du document auquel rattacher l'activité.

Pattern: ^[a-fA-F0-9]{24}$
Exemple:

"618a35a36d932054e195ca0a"

documentType
enum<string>
requis

Type de document sur lequel une activité peut être créée via l'API.

Options disponibles:
acquisition,
sale,
rental,
contact
type
enum<string>
requis

Type d'activité créable via l'API (types « manuels »). Le contenu requis dans data varie : note / task → data.content ; call / message / email / meeting → data.title ; appointment → aucun champ requis.

Options disponibles:
note,
task,
call,
message,
email,
meeting,
appointment
data
object
requis

Données de l'activité. Champs attendus selon le type : content (texte) pour note / task ; title (avec content optionnel) pour call / message / email / meeting.

content accepte du texte brut ou du HTML. En texte brut, une ligne vide (\n\n) sépare deux paragraphes et un \n simple reste un retour à la ligne ; le texte est converti en HTML à l'enregistrement. Un content contenant au moins une balise est enregistré tel quel. Balises reconnues : <p>, <br>, <strong>, <em>, <u>, <s>, <code>, <pre>, <ul> / <ol> / <li>, <h1>-<h3>, <blockquote>, <a href> en http/https.

deadline
string

Échéance de l'activité (date ISO 8601). Renseignée sans completionDate, elle crée un rappel programmé : l'activité reste « à faire » et remonte dans les relances du négociateur.

completionDate
string

Date de réalisation (ISO 8601). À renseigner pour consigner une action déjà effectuée (compte-rendu d'appel a posteriori). Si elle est fournie, la deadline que vous envoyez est écartée — une activité terminée n'a plus d'échéance à venir.

La réponse renvoie malgré tout une deadline, qui vaut alors la completionDate : c'est la date que la fiche affiche, pour qu'un rendez-vous consigné après coup apparaisse à sa date réelle et non à celle de l'appel API.

owner
string

Collaborateur à qui attribuer l'activité — celui qui a réellement passé l'appel. Par défaut, l'activité est attribuée au propriétaire du document lié.

Deux contrôles s'appliquent, et le second est le plus strict : le collaborateur doit appartenir aux agences de votre clé (sinon 400 owner is not in the authorized scope of this LinkedAPI) et, sur une vente, à l'agence du document visé (sinon 400 Activity's sale owner not found).

GET /users ne renvoie pas les agences d'un collaborateur : vous ne pouvez pas savoir à l'avance lequel est valide pour une vente donnée. En pratique, omettez owner sauf certitude.

Pattern: ^[a-fA-F0-9]{24}$
Exemple:

"618a35a36d932054e195ca0a"

Réponse

Activité créée.

success
boolean
activity
object

Activité liée à un document Avest (note, tâche, appel, email, changement d'étape, etc.).