Add/Update Site Group
If a business has multiple sites or locations, you can organize them by putting them all in a single Site Group.
Punto Final
The following endpoint can be used to add or update site groups. You must replace the {base_url} variable.
POST
{base_url}/api/v4/siteGroup/addUpdate
La misma ruta de acceso se utiliza para agregar o actualizar a Grupo de sitio. Si el {_id} se proporciona, el Grupo de sitio se actualizará de lo contrario se insertará.
Solicitud
Campo
Tipo
Descripción
externalId
String
The unique site group 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
El nombre del grupo del sitio.
agency
Agency
Una referencia al registro de la agencia.
siteEnterprise
Una referencia al registro de la empresa del sitio.
deleted
Boolean
Esta bandera representa si el registro ha sido eliminado y ya no está disponible para ser utilizado.
Respuesta
Campo
Tipo
Descripción
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"
]
}