Skip to main content

Add Site

Support avatar
Written by Support
Updated over 6 months ago

POST [ work-order ]

Production Endpoint: 
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/site

Overview

This endpoint adds Site data to the ComplyFlow system.


Authentication instructions

Refer to the Authentication method for Authentication Methods (for Login and Logout).

Permissions Required

The user should possess the permissions below:

  • API User

  • User is Staff

  • Users have Access to View and Edit Site Permission

Please also refer to the Permissions Overview guide

Body properties/Payload

FIELD

TYPE

DESCRIPTION

REQUIRED

siteName

string

Site Name

Check Mark

startDate

date

Site Start Date

Cross Mark

country

string

SIte Country

Cross Mark

code

string

Site Code

Cross Mark

parentSiteId

integer

Site ID to assign as Parent of new Site

Cross Mark

Request Example

curl --location 'https://test.complyflow.com.au/app/public/index.php/api/site' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--header 'Cookie: [...]' \
--data '{
"siteName": "Test",
"country": "Australia",
"startDate": "2025-01-01"
}'

Response Example

{
"token": "",
"data": {
"success": true,
"siteId": 415,
"message": "Site created successfully",
"successCode": "SITE_CREATED",
"statusCode": 201
}
}


Did this answer your question?