networkIdstring(uuid)required
Network Id
Create an intermediary
post
Path Parameters
Body
Body
Intermediary Data
* Additional properties are NOT allowed.
realEstateIntermediaryExternalIdstringrequired
Your internal id for the intermediary
>= 3 characters<= 20 characters
Example:id-int-42
siretstring | null
Company siret number
Match pattern:^[0-9]{9,14}$
Example:71425177424826
registeredCompanyNamestringrequired
The legal company name registered
>= 2 characters<= 255 characters
Example:SARL Agence Dupont
commercialNamestringrequired
The company commercial name
>= 2 characters<= 100 characters
Example:Dupont immobilier 15ème
emailstringrequired
Email address
>= 1 characters
Example:jean.dupont@gmail.com
phonestringrequired
Phone number
>= 1 characters
Example:+330601020304
realEstateIntermediaryURLstring | null
Intermediary’s website url
Example:https://google.com
contactsarray[object]required
Admin and principal contacts information are required
* Additional properties are NOT allowed.
Show Child Parameters
addressobjectrequired
Company address
* Additional properties are NOT allowed.
Show Child Parameters
socialNetworksarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
logosarray | null[object]
Company logos
* Additional properties are NOT allowed.
Show Child Parameters
legalInformationsarray | null[object]
Company legal informations
* Additional properties are NOT allowed.
Show Child Parameters
openingHoursarray | null[object]
Heures d’ouvertures et fermetures
* Additional properties are NOT allowed.
Show Child Parameters
closurePeriodsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
presentationsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
activityobject
* Additional properties are NOT allowed.
Show Child Parameters
scaleOfFeesURLstring | null
The URL of your slace of fees in PDF
Example:https://yourdomain.com/honoraires.pdf
secondaryExternalIdstring | null
Specific id to match classifieds from flow
>= 0 characters<= 10 characters
Example:MatchingId-for-classifieds
accountCategorystringrequired
Category of account. Possible values :
[Agence de Pub, Agence Immobilière, Agent Commercial, Agent Commercial en Portage, Annonceur, Architecte, Avocat, Camping, cat1, cat2, cat3, cat4, Commercialisateur Neuf, Conseil en Immobilier d’Entreprise, Conseil/Gestion, Constructeur Maison Individuelle, Huissier, Institutionnel, Maître d’oeuvre, Notaire, Point de Vente/Marque, Portail de Diffusion, Promoteur, Régie Publicitaire, Relais Départementaux, Résidence & Village de vacances, Société Civile Immobilière, Tours Opérateurs et Partenaires Généraux]
>= 1 characters
Example:Agence Immobilière
Response
application/json
Response
application/json
The intermediary is successfully created.
CreateIntermediaryResponse
* Additional properties are NOT allowed.
externalIdstring | null
post/intermediaries/{networkId}
Authentication
Path Parameters
Body
{
"realEstateIntermediaryExternalId": "id-int-42",
"registeredCompanyName": "SARL Agence Dupont",
"commercialName": "Dupont immobilier 15ème",
"email": "jean.dupont@gmail.com",
"phone": "+330601020304",
"contacts": [
{
"type": "admin",
"title": "Monsieur",
"firstname": "Jean",
"lastname": "Dupont",
"email": "jean.dupont@gmail.com",
"phone": "+330601020304"
}
],
"address": {
"street": "Rue des Italiens",
"postalCode": "75009",
"city": "Paris 9ème",
"countryCode": "FR"
},
"accountCategory": "Agence Immobilière"
}
application/json
Get intermediaries by Network Id
get
Query Parameters
searchTextstring
Search text
pageNumberinteger(int32)required
>= 1<= 200
pageSizeinteger(int32)required
>= 0<= 200
fromDatestring(date-time)
Search from date
toDatestring(date-time)
Search to date
statusesarray[string]
Allowed values:ActiveInProgressNotCreatedArchivedError
Path Parameters
networkIdstring(uuid)required
Network Id
Response
application/json
Response
application/json
0 or more intermediaries are found and retrieved
PaginatedIntermediariesResponse
* Additional properties are NOT allowed.
itemsarray | null[object]
Intremediary Response
* Additional properties are NOT allowed.
Show Child Parameters
totalinteger(int32)
get/intermediaries/{networkId}
Authentication
Path Parameters
Query Parameters
application/json
Get an intermediary by Id
get
Path Parameters
networkIdstring(uuid)required
Network Id
intermediaryExternalIdstringrequired
Intermediary Id
Response
application/json
Response
application/json
The intermediary is found and retrieved.
IntermediaryResponse
Intremediary Response
* Additional properties are NOT allowed.
realEstateIntermediaryExternalIdstringrequired
Your internal id for the intermediary
>= 3 characters<= 20 characters
Example:id-int-42
siretstring | null
Company siret number
Match pattern:^[0-9]{9,14}$
Example:71425177424826
registeredCompanyNamestringrequired
The legal company name registered
>= 2 characters<= 255 characters
Example:SARL Agence Dupont
commercialNamestringrequired
The company commercial name
>= 2 characters<= 100 characters
Example:Dupont immobilier 15ème
emailstringrequired
Email address
>= 1 characters
Example:jean.dupont@gmail.com
phonestringrequired
Phone number
>= 1 characters
Example:+330601020304
realEstateIntermediaryURLstring | null
Intermediary’s website url
Example:https://google.com
contactsarray[object]required
Admin and principal contacts information are required
* Additional properties are NOT allowed.
Show Child Parameters
addressobjectrequired
Company address
* Additional properties are NOT allowed.
Show Child Parameters
socialNetworksarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
logosarray | null[object]
Company logos
* Additional properties are NOT allowed.
Show Child Parameters
legalInformationsarray | null[object]
Company legal informations
* Additional properties are NOT allowed.
Show Child Parameters
openingHoursarray | null[object]
Heures d’ouvertures et fermetures
* Additional properties are NOT allowed.
Show Child Parameters
closurePeriodsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
presentationsarray | null[object]
* Additional properties are NOT allowed.
Show Child Parameters
activityobject
* Additional properties are NOT allowed.
Show Child Parameters
scaleOfFeesURLstring | null
The URL of your slace of fees in PDF
Example:https://yourdomain.com/honoraires.pdf
creationDatestring(date-time)
Creation Date
get/intermediaries/{networkId}/{intermediaryExternalId}
Authentication
Path Parameters
application/json
Patch an intermediary
patch
Path Parameters
networkIdstring(uuid)required
Network Id
intermediaryExternalIdstringrequired
Intermediary Id
Body
application/json-patch+json
Body
application/json-patch+json
Intermediary patch data
JsonPatchDocument
Array of operations to perform
opstring
valuestring
pathstring
Response
Response
The intermediary is successfully updated.
patch/intermediaries/{networkId}/{intermediaryExternalId}
Authentication
Path Parameters
Body
[
{
"value": "https://google.com",
"path": "/realEstateIntermediaryURL",
"op": "replace"
},
{
"value": "admin",
"path": "/contacts/0/type",
"op": "replace"
},
{
"value": "Monsieur",
"path": "/contacts/0/title",
"op": "replace"
},
{
"value": "Jean",
"path": "/contacts/0/firstname",
"op": "replace"
},
{
"value": "Dupont",
"path": "/contacts/0/lastname",
"op": "replace"
},
{
"value": "jean.dupont@gmail.com",
"path": "/contacts/0/email",
"op": "replace"
},
{
"value": "+330601020304",
"path": "/contacts/0/phone",
"op": "replace"
},
{
"value": "Rue des Italiens",
"path": "/address/street",
"op": "replace"
},
{
"value": "2",
"path": "/address/houseNumber",
"op": "replace"
},
{
"value": "Rez de chaussée",
"path": "/address/addressComplement",
"op": "replace"
},
{
"value": "75009",
"path": "/address/postalCode",
"op": "replace"
},
{
"value": "Paris 9ème",
"path": "/address/city",
"op": "replace"
},
{
"value": "FR",
"path": "/address/countryCode",
"op": "replace"
},
{
"value": "facebook",
"path": "/socialNetworks/0/socialNetworkName",
"op": "replace"
},
{
"value": "https://yourdomain.com/logo.svg",
"path": "/socialNetworks/0/socialNetworkLogoURL",
"op": "replace"
},
{
"value": "sl",
"path": "/logos/0/medium",
"op": "replace"
},
{
"value": "https://yourdomain.com/logo.svg",
"path": "/logos/0/logoUrl",
"op": "replace"
},
{
"value": "transaction",
"path": "/legalInformations/0/activityType",
"op": "replace"
},
{
"value": "SARL",
"path": "/legalInformations/0/legalForm",
"op": "replace"
},
{
"value": "Agence Dupont",
"path": "/legalInformations/0/registeredCompanyName",
"op": "replace"
},
{
"value": "",
"path": "/legalInformations/0/corporateCardNumber",
"op": "replace"
},
{
"value": "",
"path": "/legalInformations/0/registeredPrefecture",
"op": "replace"
},
{
"value": "",
"path": "/legalInformations/0/financialWarrantyFund",
"op": "replace"
},
{
"value": "Paris 9ème",
"path": "/legalInformations/0/commercialRegisterCity",
"op": "replace"
},
{
"value": "T",
"path": "/legalInformations/0/commercialRegisterLetter",
"op": "replace"
},
{
"value": "123123123",
"path": "/legalInformations/0/commercialRegisterSiren",
"op": "replace"
},
{
"value": "23945",
"path": "/legalInformations/0/commercialRegisterNic",
"op": "replace"
},
{
"value": "FR29789177391",
"path": "/legalInformations/0/vATNumber",
"op": "replace"
},
{
"value": "Rue des Italiens",
"path": "/legalInformations/0/headQuarterAddress/street",
"op": "replace"
},
{
"value": "2",
"path": "/legalInformations/0/headQuarterAddress/houseNumber",
"op": "replace"
},
{
"value": "Rez de chaussée",
"path": "/legalInformations/0/headQuarterAddress/addressComplement",
"op": "replace"
},
{
"value": "75009",
"path": "/legalInformations/0/headQuarterAddress/postalCode",
"op": "replace"
},
{
"value": "Paris 9ème",
"path": "/legalInformations/0/headQuarterAddress/city",
"op": "replace"
},
{
"value": "FR",
"path": "/legalInformations/0/headQuarterAddress/countryCode",
"op": "replace"
},
{
"value": "monday",
"path": "/openingHours/0/day",
"op": "replace"
},
{
"value": "08:00",
"path": "/openingHours/0/morning/start",
"op": "replace"
},
{
"value": "18:00",
"path": "/openingHours/0/morning/stop",
"op": "replace"
},
{
"value": "08:00",
"path": "/openingHours/0/afternoon/start",
"op": "replace"
},
{
"value": "18:00",
"path": "/openingHours/0/afternoon/stop",
"op": "replace"
},
{
"value": "Fermeture estivale",
"path": "/closurePeriods/0/title",
"op": "replace"
},
{
"value": "2024-12-19T16:19:48.5559886+00:00",
"path": "/closurePeriods/0/startDate",
"op": "replace"
},
{
"value": "2024-12-19T16:19:48.5559886+00:00",
"path": "/closurePeriods/0/endDate",
"op": "replace"
},
{
"value": "sl",
"path": "/presentations/0/medium",
"op": "replace"
},
{
"value": 0,
"path": "/presentations/0/activity/languages/0/isoCode",
"op": "replace"
},
{
"value": "string",
"path": "/presentations/0/activity/languages/0/teaser",
"op": "replace"
},
{
"value": "string",
"path": "/presentations/0/activity/languages/0/description",
"op": "replace"
},
{
"value": "https://yourdomain.com/picture.svg",
"path": "/presentations/0/presentationPictureURL",
"op": "replace"
},
{
"value": "sl",
"path": "/presentations/0/team/medium",
"op": "replace"
},
{
"value": "Dupont expert incontournable de l'immobilier Paris 9",
"path": "/presentations/0/team/teaser",
"op": "replace"
},
{
"value": "L'équipe est composé de talents a compétences multiples...",
"path": "/presentations/0/team/description",
"op": "replace"
},
{
"value": "https://yourdomain.com/team.svg",
"path": "/presentations/0/team/teamPictureURL",
"op": "replace"
},
{
"value": "Dupont",
"path": "/presentations/0/team/members/0/name",
"op": "replace"
},
{
"value": "Jean",
"path": "/presentations/0/team/members/0/firstName",
"op": "replace"
},
{
"value": "Directeur",
"path": "/presentations/0/team/members/0/role",
"op": "replace"
},
{
"value": "+330601020304",
"path": "/presentations/0/team/members/0/phone",
"op": "replace"
},
{
"value": "jean.dupont@gmail.com",
"path": "/presentations/0/team/members/0/email",
"op": "replace"
},
{
"value": "Jean Dupont expert de l'immobilier depuis 1968...",
"path": "/presentations/0/team/members/0/presentation",
"op": "replace"
},
{
"value": "https://yourdomain.com/profile.png",
"path": "/presentations/0/team/members/0/memberPictureURL",
"op": "replace"
},
{
"value": "2",
"path": "/activity/activityPursued",
"op": "replace"
},
{
"value": "75009",
"path": "/activity/activityPostalCode",
"op": "replace"
},
{
"value": "Île-de-France",
"path": "/activity/activityCity",
"op": "replace"
},
{
"value": "https://yourdomain.com/honoraires.pdf",
"path": "/scaleOfFeesURL",
"op": "replace"
},
{
"value": "id-int-42",
"path": "/realEstateIntermediaryExternalId",
"op": "replace"
},
{
"value": "71425177424826",
"path": "/siret",
"op": "replace"
},
{
"value": "SARL Agence Dupont",
"path": "/registeredCompanyName",
"op": "replace"
},
{
"value": "Dupont immobilier 15ème",
"path": "/commercialName",
"op": "replace"
},
{
"value": "jean.dupont@gmail.com",
"path": "/email",
"op": "replace"
},
{
"value": "+330601020304",
"path": "/phone",
"op": "replace"
}
]
Delete an intermediary
delete
Path Parameters
networkIdstring(uuid)required
Network Id
intermediaryExternalIdstringrequired
Intermediary Id
Response
Response
The intermediary is successfully deleted.
delete/intermediaries/{networkId}/{intermediaryExternalId}