Skip to main content
Skip table of contents

Create an intercom group

Create a group

JSON
{
    "name": "name",
    "parent_id": 2,
    "is_house": true
}

POST /api/admin/v1/intercoms/groups

Parameters

string name, Group name


int parent_id, Id of the group that will be considered the parent for the created group


bool is_house, Is a house

201 Created

Successful response

JSON
{
    "id": 1,
    "name": "Source cameras",
    "full_pretty": null,
    "is_house": 0,
    "cameras_count": 0,
    "parent_id": null,
    "csa_id": null,
    "intercoms_count": 0
}

401 Unauthorized

Authorization token not sent or not valid

422 Unprocessable Entity

Returns a JSON object with an error.

JSON
{
    "message": "There will be no informative message here",
    "errors": {
        "any_key": [
            "The cause of the error will be described here"
        ]
    }
}
cURL
BASH
curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/intercoms/groups' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "name": "string",
    "parent_id": 0,
    "is_house": true
}'
PHP
PHP
$data = array (
  'name' => 'string',
  'parent_id' => 0,
  'is_house' => true,
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'POST',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/intercoms/groups', false, $context);
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.