group

Create and/or update group profile records

Creates new organizational groups or updates existing group configurations in bulk. Groups organize users, campaigns, and call flows in a hierarchical structure for permissions and reporting.

post/group

Request

  • Base URL
    https://apicfa.conviza.com/v2
  • URL
    https://apicfa.conviza.com/v2/group
  • Auth
    none declared

Request body

group_idinteger

Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.

group_ext_idstring

A user defined external identifier for the group. Type: string.

group_namestring required

Human-readable name of the organization unit/group. String.

group_parent_idinteger

The unique ID for the group that would be a parent to the current group. Type: integer (int32).

top_group_idinteger

The unique ID for the top level group associated with current group. Type: integer (int32).

billing_idinteger

The unique ID for the group that is the billing node. Type: integer (int32).

addressstring

Caller's street address. String.

citystring

Caller's city (from caller-ID/location lookup). String.

statestring

Caller's state (from caller-ID/location lookup). String (two-letter US state code).

zipstring

The zip code for the group. Type: string.

phone_numberstring

Phone number as a string of digits. Typically 10 digits for US numbers.

group_createdstring date

The date and time when the group was created. Type: string (date).

group_modifiedstring date-time

The date and time when the group was last updated. Type: string (date-time).

industry_idinteger

The unique identifier for the industry selected. Type: integer (int32).

industry_namestring

The name of the industry selected. Type: string.

Response

Created or updated group IDs with sequential order numbers matching submission order

resultstring required

Outcome of the request. String, typically 'success' or 'error'.

datastring required

Response payload. Shape varies by endpoint.

entry_countinteger required

The sequential number of the entry in the submitted array. Type: integer (int32).

Changes

No recorded changes to this operation across all 2 revisions of this API.