POST
/
candidates
/
create
/
{id}
cURL
curl --request POST \
  --url https://flatbay.fr/fr/api/candidates/create/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "users": [
    {
      "firstName": "Jean",
      "lastName": "Dupont",
      "email": "jean.dupont@example.com",
      "phone": "+33612345678",
      "civility": "user.civility.m",
      "birthDate": "1990-01-15",
      "nationality": "FR",
      "situationfamiliale": "user.situationfamiliale.celib",
      "groupe": "user.groupe.seul",
      "optin": "1"
    }
  ]
}
'
{
  "status": "ok"
}

​
Endpoint

POST /api/candidates/create/:id?apiKey=xxxxx
Il faudra que l’équipe Flatbay vous fournisse une clé API pour utiliser cette route.

​
Description

Cette route permet de créer une ou plusieurs candidatures pour un bien donné. Pour chaque utilisateur dans le tableau users, une candidature sera créée avec:
  • Statut: candidate.status.demande (Non traitée)
  • Type: candidate.type.seul (Seul)
  • Candidate: 0 (prospect)

​
Paramètres

​
Path Parameter

ParamètreTypeRequisDescription
idintegerOuiIdentifiant de la propriété

​
Query Parameters

ParamètreTypeRequisDescription
apiKeystringOuiVotre clé API
roomIdintegerNonIdentifiant de la chambre (colocation)

​
Corps de la requête

ChampTypeRequisDescription
usersarrayOuiListe des utilisateurs à créer

​
Champs utilisateur

ChampTypeDescription
firstNamestringPrénom
lastNamestringNom
emailstringEmail
phonestringTéléphone
civilitystringCivilité (user.civility.m, user.civility.mme, user.civility.other)
birthDatestringDate de naissance (YYYY-MM-DD)
nationalitystringNationalité (code pays)
situationfamilialestringSituation familiale
groupestringGroupe
optinstring”1” pour activer l’opt-in marketing

​
Valeurs possibles pour situationfamiliale

  • user.situationfamiliale.celib - Célibataire
  • user.situationfamiliale.concub - Concubin
  • user.situationfamiliale.marie - Marié(e)
  • user.situationfamiliale.div - Divorcé(e)
  • user.situationfamiliale.veuf - Veuf(ve)
  • user.situationfamiliale.pacse - Pacsé(e)

​
Valeurs possibles pour groupe

  • user.groupe.seul - Seul
  • user.groupe.couple - Couple
  • user.groupe.groupe - Groupe
  • user.groupe.personne.morale - Personne morale

​
Exemple de requête

{
  "users": [
    {
      "firstName": "Jean",
      "lastName": "Dupont",
      "email": "jean.dupont@example.com",
      "phone": "+33612345678",
      "civility": "user.civility.m",
      "birthDate": "1990-01-15",
      "nationality": "FR",
      "situationfamiliale": "user.situationfamiliale.celib",
      "groupe": "user.groupe.seul",
      "optin": "1"
    }
  ]
}

​
Réponse

{
  "status": "ok"
}

Path Parameters

​
id
enum<integer>
required

Identifiant de la propriété pour laquelle créer les candidatures Identifiant du bien

Available options:
1,
3,
4,
5,
6,
7,
8,
9,
10
Example:

1

Query Parameters

​
apiKey
string
required

Mot de passe pour l'accès sécurisé

Example:

"api_key_here"

​
roomId
integer

Identifiant de la chambre (pour les colocations avec bail individuel) Id de la chambre

Example:

1

Body

application/json

Liste des utilisateurs à ajouter comme candidats

​
users
object[]
required

Liste des utilisateurs à ajouter comme candidats

Minimum array length: 1

Response

Candidatures créées avec succès

Retour positif du serveur

​
status
string

Statut de la requête

Example:

"ok"