> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arquos.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Créer un relevé Arquos

> Cette fonctionnalité permet de créer un nouveau relevé sur Arquos sur un ou plusieurs équipements.

### Endpoint & Authentification

| Méthode | URL                                              |
| :------ | :----------------------------------------------- |
| `POST`  | `https://app.arquos.eu/api/1.1/wf/create_survey` |

**En-têtes (Headers) :**

* `x-api-key: [VOTRE_API_KEY]`

<Note>
  La clé API est propre à chaque partenaire et n'est autorisée que sur les agences qui lui ont été attribuées. Un appel avec une clé invalide, ou visant une agence non autorisée, n'est pas exécuté (le relevé n'est pas créé).
</Note>

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

<ParamField body="agency_id" type="string" required>
  Identifiant unique de l'agence.
</ParamField>

<ParamField body="type_affaire" type="string">
  Requis si `type_etat_des_lieux` est vide.

  Valeurs : `Contrat`, `Réparation`, `Modernisation pour devis`, `Remplacement complet pour devis`, `Modernisation pour commande` ou `Remplacement complet pour commande`.
</ParamField>

<ParamField body="type_etat_des_lieux" type="array">
  Requis si `type_affaire` est vide.

  Valeurs possibles : `Prise en mains`, `Essais`, `Base parc`.
</ParamField>

<ParamField body="solliciteur_email" type="string" required>
  Email de l'initiateur de la demande.
</ParamField>

<ParamField body="releveur_email" type="string" required>
  Email du technicien affecté.
</ParamField>

<ParamField body="equipments" type="object[]" required>
  Liste des équipements concernés par le relevé.

  <Expandable title="Détails de l'objet équipement" defaultOpen="true">
    <ParamField body="equipment_number" type="string" required>
      Numéro unique de l'appareil.
    </ParamField>

    <ParamField body="adresse" type="string" required>
      Adresse de l'immeuble.
    </ParamField>

    <ParamField body="complement_adresse" type="string">
      Bâtiment, étage, etc.
    </ParamField>

    <ParamField body="consignes_acces" type="array">
      Valeurs possibles : `Sans`, `Digicode`, `Coffre à clé`, `Vigik` ou `Autre`.
    </ParamField>

    <ParamField body="consignes_acces_autre" type="string">
      Précisions si `Autre` est sélectionné.
    </ParamField>

    <ParamField body="digicode" type="string">
      Code d'entrée.
    </ParamField>

    <ParamField body="coffre_a_cles" type="string">
      Emplacement des clés.
    </ParamField>

    <ParamField body="client_id" type="string">
      ID interne du client gestionnaire.
    </ParamField>

    <ParamField body="client_nom" type="string">
      Nom du client gestionnaire.
    </ParamField>

    <ParamField body="client_telephone" type="string">
      Numéro de téléphone du client gestionnaire.
    </ParamField>

    <ParamField body="client_adresse" type="string">
      Adresse postale du client gestionnaire.
    </ParamField>

    <ParamField body="client_siret" type="string">
      Numéro SIRET du client gestionnaire.
    </ParamField>

    <ParamField body="client_siren" type="string">
      Numéro SIREN du client gestionnaire.
    </ParamField>
  </Expandable>
</ParamField>

<RequestExample>
  ```json JSON theme={null}
  {
    "agency_id": "test_agency_01",
    "type_affaire": "",
    "solliciteur_email": "test+202244@arquos.eu",
    "releveur_email": "test+028910@arquos.eu",
    "type_etat_des_lieux": ["Prise en mains", "Essais"],
    "external_opportunity_id": "OPP-2026-00042",
    "equipments": [
      {
        "equipment_number": "ASC_45678",
        "adresse": "29 Rue Bontemps, 33400 Talence, France",
        "complement_adresse": "BAT A",
        "consignes_acces": ["Digicode", "Autre"],
        "consignes_acces_autre": "Sonner à l'interphone 'Gardien'",
        "digicode": "A123",
        "client_id": "CLI-882",
        "client_nom": "ImmoGestion Sud",
        "client_telephone": "0123456789"
      },
      {
        "equipment_number": "ASC_89023",
        "adresse": "29 Rue Bontemps, 33400 Talence, France",
        "complement_adresse": "BAT B",
        "consignes_acces": ["Digicode", "Autre"],
        "consignes_acces_autre": "Sonner à l'interphone 'Gardien'",
        "digicode": "A123",
        "client_id": "CLI-882",
        "client_nom": "ImmoGestion Sud",
        "client_telephone": "0123456789"
      }
    ]
  }
  ```

  ```bash cURL theme={null}
  curl --request POST \
    --url https://app.arquos.eu/api/1.1/wf/create_survey \
    --header 'x-api-key: VOTRE_API_KEY' \
    --header 'Content-Type: application/json' \
    --data '{
    "agency_id": "test_agency_01",
    "type_affaire": "",
    "solliciteur_email": "test+202244@arquos.eu",
    "releveur_email": "test+028910@arquos.eu",
    "type_etat_des_lieux": ["Prise en mains", "Essais"],
    "external_opportunity_id": "OPP-2026-00042",
    "equipments": [
      {
        "equipment_number": "ASC_45678",
        "adresse": "29 Rue Bontemps, 33400 Talence, France",
        "complement_adresse": "BAT A",
        "consignes_acces": ["Digicode", "Autre"],
        "consignes_acces_autre": "Sonner à l'interphone 'Gardien'",
        "digicode": "A123",
        "client_id": "CLI-882",
        "client_nom": "ImmoGestion Sud",
        "client_telephone": "0123456789"
      },
      {
        "equipment_number": "ASC_89023",
        "adresse": "29 Rue Bontemps, 33400 Talence, France",
        "complement_adresse": "BAT B",
        "consignes_acces": ["Digicode", "Autre"],
        "consignes_acces_autre": "Sonner à l'interphone 'Gardien'",
        "digicode": "A123",
        "client_id": "CLI-882",
        "client_nom": "ImmoGestion Sud",
        "client_telephone": "0123456789"
      }
    ]
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "status": "success",
    "response": {
      "id_affaire": "1784193778642x782286771798901300"
    }
  }
  ```
</ResponseExample>