Passer au contenu principal
POST
Créer une visite sur une mise en relation

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

matchId
string
requis

Identifiant Mongo (24 caractères hexadécimaux).

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

"618a35a36d932054e195ca0a"

Corps

application/json
visitStartAt
string<date-time>
requis

Début de la visite. Une date passée crée une visite déjà réalisée.

visitEndAt
string<date-time>
content
string

Note libre attachée à la visite.

owner
string

Agent à qui attribuer la visite ; doit appartenir au périmètre du token. Par défaut, le responsable du match.

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

"618a35a36d932054e195ca0a"

Réponse

Visite créée.

success
boolean
visit
object

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