create or update a user, and conditionally commit the user's data

post

https://example.com/api-ext/domain/{domain}/user

This "upsert" API synchronously processes a user's data and returns the processing report. If any error(s) occurs during the processing, the report will include error information and a BadRequest response will be returned.

This API can be exercised in dry-run mode by setting the commit query parameter as follows. If commit is false, user data will be validated but there is no persistence of the user data in Cogito services. If commit is true, user data will be validated and user objects will be persisted for users with no validation errors. By default, commit is true.

Processing may take a relatively long amount of time so the request's timeout should be set accordingly.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

domain

string

required

client's namespace

Query Params

commit

string

Defaults to true

flag to indicate dry-run option

Body Params

inputFormat

string

enum

Allowed:

userName

string

required

immutable user ID

salutation

string

salutation e.g. Mr., Miss

firstName

string

required

user's first name (aka given name)

middleName

string

user's middle name or initial

lastName

string

required

user's last name (aka family name)

suffix

string

user's suffix e.g. Jr., IV

jobTitle

string

required

job title

pilotParticipant

string

If the user is participating in a pilot, this field should be set to Test or Control.

status

string

required

status of the user's account; must be Active, or Inactive

wfh

string

set to Y if the user works from home and set to N if the user does not work from home

organization

string

required

user's primary Organization

contactCenter

string

required

user's Contact Center

site

string

required

user's Site

roles

array of strings

required

user's role(s) e.g. Agent, Supervisor, Manager, etc.

roles*

teams

array of strings

user's Team(s)

teams

telephonyConfigurations

array of objects

required

telephonyConfigurations*

coachId

string

immutable ID of the user's coach

supervisor

string

user's supervisor name (should be firstName plus lastName)

supervisorId

string

immutable ID of the user's direct supervisor

string

user's email address

cogitoActivationDate

string

The date when the user was activated, in a yyyy-mm-dd format. If a date is not provided, the activation date will be set to the date the user is processed.

cogitoDeactivationDate

string

The date when the user was deactivated, in a yyyy-mm-dd format. If a user's status=Inactive and this date is not provided, the deactivation date will be set to the date the user is processed.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Ok; user processed successfully

400Bad Request; e.g. required param is missing, user is not valid JSON, user validation error

401Unauthorized; user is not authenticated to use this service

403Forbidden; user is not authorized to use this service

404Not Found; domain does not exist

406Not Acceptable; unsupported media type in Accept header