group

Creates a new user in the given group

Creates new users within a specified organizational group. Provisions user accounts with credentials, roles, and group membership in a single operation.

post/group/user

Request

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

Request body

group_idinteger

The group ID to which the user should belong to

group_ext_idstring

An external identifier set for group

first_namestring required

The users first name

last_namestring required

The users last name

user_emailstring required

The users e-mail address / login

user_ext_idstring

The users external id

ring_tointeger

The full ring-to number

agent_idinteger

An external identifier set for user

role'Admin' | 'Standard' | 'Read-Only' | 'Identified-only' required

The user account type set for user

user_status'active' | 'inactive'
aliasesstring

Optional comma separated list of user alias

timezone'America/Halifax' | 'America/New_York' | 'America/Chicago' | 'America/Denver' | 'America/Phoenix' | 'America/Los_Angeles' | 'utc' required

The users timezone

Response

Newly created user IDs with confirmation status for each user

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.