Skip to main content

​
Endpoint & Authentification

MéthodeURL
POSThttps://app.arquos.eu/api/1.1/wf/update_client
En-têtes (Headers) :
  • Authorization: Bearer [VOTRE_API_KEY]
  • Content-Type: application/json

​
Paramètres de la requête (Body)

​
agency_id
string
required
Identifiant unique de l’agence.
​
client_id
string
Requis si nom est vide.
Identifiant unique du client.
​
nom
string
Requis si client_id est vide.
Raison sociale ou nom du client.
​
statut
string
Valeurs possibles : Prospect, Client.
​
type
array
Liste de catégories. Valeurs : Propriétaire/exploitant, Gestionnaire.
​
email
string
Email principal de l’entreprise.
​
telephone
string
Standard téléphonique.
​
adresse
string
Adresse du siège social.
​
complement_adresse
string
Bâtiment, CS, etc.
​
siren
string
Numéro SIREN (9 chiffres).
​
siret
string
Numéro SIRET (14 chiffres).
​
supprime
boolean
Mettre à true pour archiver le client.
​
contact
object[]
Liste des contacts rattachés au client.
{
  "agency_id": "test_agency_01",
  "client_id": "CLI-88210",
  "nom": "ImmoGestion Nord",
  "statut": "Client",
  "type": ["Gestionnaire"],
  "email": "contact@immogestion-nord.fr",
  "telephone": "0320123456",
  "adresse": "14 Rue du Vieux Lille, 59000 Lille",
  "siren": "123456789",
  "supprime": false,
  "contact": [
    {
      "nom": "Marie Dupont",
      "email": "m.dupont@immogestion-nord.fr",
      "telephone": "0601020304",
      "fonction": "Référent sur site"
    },
    {
      "nom": "Martin Durand",
      "email": "m.durand@immogestion-nord.fr",
      "telephone": "0605060708",
      "fonction": "Gardien"
    }
  ]
}

{
  "status": "success",
  "response": {}
}