Create Group

POST

https://platform-api.convirza.com/v3/groups

Groups

Last modified:2026-07-24 13:10:44

Creates a new organizational unit (group) and positions it in the account hierarchy under the specified parent.

Business rules

org_unit_name must be unique within the parent group — two sibling groups cannot share the same name.

parent_org_unit_id must reference an existing, active org unit within the authenticated admin's hierarchy.

The hierarchy level (depth) is computed automatically from the parent's position.

A unique org_unit_id is assigned by the system.

Optional configuration

org_unit_ext_id — your own external/CRM identifier for this group, used to link records across systems.

timezone — defaults to the parent group's timezone if not provided.

Spam guard, recording, and DNI settings default to the parent group's configuration unless explicitly overridden.

Response
Returns the new org_unit_id and a success flag.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Group created successfully

Bodyapplication/json

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://platform-api.convirza.com/v3/groups' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "org_unit_name": "New Sales Division",
    "org_unit_ext_id": "ORG-2001",
    "org_unit_parent_id": 1000,
    "top_org_unit_id": 1,
    "billing_id": 1,
    "address": "123 Business Street",
    "city": "New York",
    "state": "NY",
    "zip": "10001",
    "phone_number": "+1234567890",
    "industry_id": 5
}'

Response Example

201 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "org_unit_id": 2001
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-07-24 13:10:44

Delete Group

Create Webhook