Ce qu’il faut pour créer un client

curl --request GET \
--url https://api.arquos.eu/api/v2/clients/creation \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON'

{
"type": "client",
"parent": {
  "label": "texte",
  "object": "texte",
  "required": true
},
"fields": [
  {
    "id": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
    "label": "texte",
    "required": true,
    "type": "text",
    "values": [
      "texte"
    ]
  }
]
}

curl --request GET \
--url https://api.arquos.eu/api/v2/clients/creation \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON'

{
"type": "client",
"parent": {
  "label": "texte",
  "object": "texte",
  "required": true
},
"fields": [
  {
    "id": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
    "label": "texte",
    "required": true,
    "type": "text",
    "values": [
      "texte"
    ]
  }
]
}

Endpoint & Authentification

Méthode	URL
`GET`	`https://api.arquos.eu/api/v2/clients/creation`

En-têtes (Headers) :

Authorization: Bearer [VOTRE_JETON_D_API]
X-Arquos-Agency: [IDENTIFIANT_D_AGENCE] (facultatif, voir Agence)

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).

Réponse (`200`)

string

Le type de l’objet, au singulier.

object

L’objet auquel il faut le rattacher (parentId à la création), ou null. Peut valoir null.

Show Ses champs

string

Le nom du champ parent (« Immeuble », « Client »…).

string

Le type de l’objet parent, tel que la recherche le rend.

boolean

Toujours true : sans parent, la création est refusée.

object[]

Les champs qu’on peut remplir à la création.

Show Chaque élément

string

L’identifiant du champ, la clé à envoyer dans champs à la création.

string

Son libellé, tel qu’il se lit dans Arquos.

boolean

Sans lui, la création est refusée (422).

string

Le genre de valeur attendue. Valeurs possibles : text, number, choice, multi, email, date.

string[]

Les valeurs admises pour un choix ; null sinon. Peut valoir null.

Les erreurs

Code	Quand
`400`	Requête mal formée ou champ obligatoire manquant.
`401`	Jeton absent, inconnu ou révoqué.
`403`	Agence hors de votre portée.
`404`	Objet introuvable dans vos agences.
`429`	Trop d’appels : réessayez après le délai de l’en-tête Retry-After.

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

curl --request GET \
--url https://api.arquos.eu/api/v2/clients/creation \
--header 'Authorization: Bearer arq_agent_VOTRE_JETON'

{
"type": "client",
"parent": {
  "label": "texte",
  "object": "texte",
  "required": true
},
"fields": [
  {
    "id": "3f1c2b9e-8a4d-4c1e-9b7a-2d5e6f708192",
    "label": "texte",
    "required": true,
    "type": "text",
    "values": [
      "texte"
    ]
  }
]
}

Démarrer

API REST

Centres d'appels

Agents IA

Référence · Compte

Référence · Recherche

Référence · Équipements

Référence · Relevés

Référence · Contrats

Référence · Import

Référence · Webhooks

Référence · Référentiels

Référence · Affaires

Référence · Appels

Référence · Visites

Référence · Techniciens

Référence · Pièces

Référence · Devis

Référence · Notes

Référence · Écarts et réserves

Référence · Factures

Référence · Clients

Référence · Immeubles

Référence · Contacts

Référence · Secteurs

Référence · Campagnes

Référence · Contrôles techniques

Référence · Sollicitations

Endpoint & Authentification

Paramètres de la requête

Réponse (`200`)

Les erreurs

​Endpoint & Authentification

​Paramètres de la requête

​Réponse (200)

​Les erreurs

Endpoint & Authentification

Paramètres de la requête

Réponse (`200`)

Les erreurs