Passer au contenu principal
PATCH

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.

Paramètres de chemin

activityId
string
requis

ObjectId de l'activité. Identifiant Mongo (24 caractères hexadécimaux).

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

"618a35a36d932054e195ca0a"

Corps

application/json

Au moins un champ parmi completionDate, reason, content et owner.

completionDate
string | null

Date ISO 8601 de réalisation pour clôturer l'activité, ou null pour la rouvrir. Sur une activité déjà close, la date est mise à jour sans rejouer les effets de la clôture.

reason
string

Résultat de l'action, tel que l'interface Avest le consigne pour un appel (faux numéro, non répondu, répondu, …). Stocké dans data.reason.

owner
string

Collaborateur ayant réellement traité l'activité. Doit appartenir aux agences de votre clé et, sur une vente, à l'agence de la vente. Sinon la requête est refusée (400) et rien n'est écrit : owner is not in the authorized scope of this LinkedAPI ou Activity's sale owner not found. GET /users ne renvoie pas les agences d'un collaborateur : en cas de doute, omettez owner.

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

"618a35a36d932054e195ca0a"

content
string

Nouveau texte d'une activité note — refusé sur tout autre type. Remplace data.content en entier. Texte brut ou HTML, avec la même mise en forme qu'à la création (un texte brut avec des \n est converti en paragraphes HTML).

Réponse

Activité mise à jour.

success
boolean
activity
object

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