Add/Update Site Enterprise

Use this when one business owns several Site Groups or Sites and wants to see them all in one place.


If a business is a large enterprise that requires many site groups, you can create a Site Enterprise which can contain many Site Groups.


Endpoint

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

Request
Field
Type
Description
externalId
String
Your own id for this site enterprise, from your software. Send the same externalId again to update this site enterprise instead of adding a new one.
name
String
The name of the site enterprise.
agency
Agency
A reference to the agency record.
deleted
Boolean
This flag represents whether the record is deleted and no longer available to be used.
Response
Field
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
_id
String
The id we assign to the record.
updatedAt
The date the record was last updated. A moment in time in ISO 8601, with a time zone. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
errors
String [ ]
A list of errors. Will only be returned if success is false.
			
{
  "success": true,
  "action": "added",
  "_id": "60f720d248f143332af022e0",
  "updatedAt": "2025-05-30T19:19:44.143Z"
}


		

Related