Add/Update Site Enterprise
If a business is a large enterprise that requires many site groups, you can create a Site Enterprise which can contain many Site Groups.
Point de terminaison
The following endpoint can be used to add or update site enterprises. You must replace the {base_url} variable.
POST
{base_url}/api/v4/siteEnterprise/addUpdate
Le même point de terminaison est utilisé pour ajouter ou mettre à jour a Site entreprise. Si le {_id} est fourni, le Site entreprise sera mis à jour sinon il sera inséré.
Demande
Champ
Type
Description
externalId
String
The unique site enterprise id from the source system/database. If we detect a record with the same `external_id`, it will be updated, otherwise it will be added.
name
String
Le nom de l'entreprise du site.
agency
Agency
Une référence au dossier de l'agence.
deleted
Boolean
Ce drapeau représente si l'enregistrement est supprimé et n'est plus disponible pour être utilisé.
Réponse
Champ
Type
Description
success
Boolean
Whether the record was added or updated successfully.
action
String
Informs whether the record was added or updated. Will only be returned if `success` is `true`.
One of `added`, `updated`
One of `added`, `updated`
_id
String
The auto generated id assigned to the record.
errors
String [ ]
A list of errors. Will only be returned if `success` is `false`.
Sample Response (Successful)
{
"success": true,
"action": "added",
"_id": "60f720d248f143332af022e0"
}
Sample Response (Failed)
{
"success": false,
"errors": [
"invalid field2",
"missing field_name"
]
}