group

Updates existing user having given user-id or agent-id.

Updates existing user information including profile details, permissions, and group assignments. Requires user ID or agent ID to identify the user to modify.

put/group/user

Request

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

Request body

ct_user_idinteger

The unique identifier for the user account

group_idinteger

The group ID to which the user should belong to

agent_idinteger

An external identifier set for user

first_namestring required

The users first name

last_namestring required

The users last name

user_emailstring required

The users e-mail address / login

ring_tointeger

The full ring-to number

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

Updated user details with confirmation status

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.