> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# genesys-users
> Genesys Users - user profiles, presence, groups, teams, search, station management, and role assignment
**Server path:** `/genesys-users` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`genesys_users_delete_group`](#genesys_users_delete_group) | Delete group |
| [`genesys_users_delete_group_members`](#genesys_users_delete_group_members) | Remove members |
| [`genesys_users_delete_presence_definition`](#genesys_users_delete_presence_definition) | Delete a Presence Definition |
| [`genesys_users_delete_presence_source`](#genesys_users_delete_presence_source) | Delete a Presence Source |
| [`genesys_users_delete_stations_me_associatedstation`](#genesys_users_delete_stations_me_associatedstation) | Clear self associated station |
| [`genesys_users_delete_team`](#genesys_users_delete_team) | Delete team |
| [`genesys_users_delete_team_members`](#genesys_users_delete_team_members) | Delete team members |
| [`genesys_users_delete_user`](#genesys_users_delete_user) | Delete user |
| [`genesys_users_delete_user_station_associatedstation`](#genesys_users_delete_user_station_associatedstation) | Clear associated station |
| [`genesys_users_delete_user_station_defaultstation`](#genesys_users_delete_user_station_defaultstation) | Clear default station |
| [`genesys_users_get_authorization_divisionspermitted_paged_me`](#genesys_users_get_authorization_divisionspermitted_paged_me) | Returns which divisions the current user has the given permission in. |
| [`genesys_users_get_documentation_gkn_search`](#genesys_users_get_documentation_gkn_search) | Search gkn documentation using the q64 value returned from a previous search |
| [`genesys_users_get_documentation_search`](#genesys_users_get_documentation_search) | Search documentation using the q64 value returned from a previous search |
| [`genesys_users_get_group`](#genesys_users_get_group) | Get group |
| [`genesys_users_get_group_individuals`](#genesys_users_get_group_individuals) | Get all individuals associated with the group |
| [`genesys_users_get_group_members`](#genesys_users_get_group_members) | Get group members, includes individuals, owners, and dynamically included people |
| [`genesys_users_get_groups`](#genesys_users_get_groups) | Get a group list |
| [`genesys_users_get_groups_search`](#genesys_users_get_groups_search) | Search groups using the q64 value returned from a previous search |
| [`genesys_users_get_locations_search`](#genesys_users_get_locations_search) | Search locations using the q64 value returned from a previous search |
| [`genesys_users_get_me`](#genesys_users_get_me) | Get current user details. |
| [`genesys_users_get_presence_definition`](#genesys_users_get_presence_definition) | Get a Presence Definition |
| [`genesys_users_get_presence_definitions`](#genesys_users_get_presence_definitions) | Get a list of Presence Definitions |
| [`genesys_users_get_presence_settings`](#genesys_users_get_presence_settings) | Get the presence settings |
| [`genesys_users_get_presence_source`](#genesys_users_get_presence_source) | Get a Presence Source |
| [`genesys_users_get_presence_sources`](#genesys_users_get_presence_sources) | Get a list of Presence Sources |
| [`genesys_users_get_presence_user_primarysource`](#genesys_users_get_presence_user_primarysource) | Get a user's Primary Presence Source |
| [`genesys_users_get_query`](#genesys_users_get_query) | Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is required |
| [`genesys_users_get_search`](#genesys_users_get_search) | Search users using the q64 value returned from a previous search |
| [`genesys_users_get_search`](#genesys_users_get_search) | Search users using the q64 value returned from a previous search |
| [`genesys_users_get_search_suggest`](#genesys_users_get_search_suggest) | Suggest resources using the q64 value returned from a previous suggest query. |
| [`genesys_users_get_stations_me`](#genesys_users_get_stations_me) | Get station information for self |
| [`genesys_users_get_systempresences`](#genesys_users_get_systempresences) | Get the list of SystemPresences |
| [`genesys_users_get_team`](#genesys_users_get_team) | Get team |
| [`genesys_users_get_team_members`](#genesys_users_get_team_members) | Get team membership |
| [`genesys_users_get_teams`](#genesys_users_get_teams) | Get Team listing |
| [`genesys_users_get_telephony_providers_edges_sites_search`](#genesys_users_get_telephony_providers_edges_sites_search) | Search sites using the q64 value returned from a previous search |
| [`genesys_users_get_user`](#genesys_users_get_user) | Get user. |
| [`genesys_users_get_user_callforwarding`](#genesys_users_get_user_callforwarding) | Get a user's CallForwarding |
| [`genesys_users_get_user_directreports`](#genesys_users_get_user_directreports) | Get direct reports |
| [`genesys_users_get_user_geolocation`](#genesys_users_get_user_geolocation) | Get a user's Geolocation |
| [`genesys_users_get_user_outofoffice`](#genesys_users_get_user_outofoffice) | Get a OutOfOffice |
| [`genesys_users_get_user_presence`](#genesys_users_get_user_presence) | Get a user's Presence |
| [`genesys_users_get_user_presences_purecloud`](#genesys_users_get_user_presences_purecloud) | Get a user's Genesys Cloud presence. |
| [`genesys_users_get_user_profileskills`](#genesys_users_get_user_profileskills) | List profile skills for a user |
| [`genesys_users_get_user_queues`](#genesys_users_get_user_queues) | Get queues for user |
| [`genesys_users_get_user_roles`](#genesys_users_get_user_roles) | Returns a listing of roles and permissions for a user. |
| [`genesys_users_get_user_routinglanguages`](#genesys_users_get_user_routinglanguages) | List routing languages assigned to a user |
| [`genesys_users_get_user_routingskills`](#genesys_users_get_user_routingskills) | List routing skills assigned to a user |
| [`genesys_users_get_user_routingstatus`](#genesys_users_get_user_routingstatus) | Fetch the routing status of a user |
| [`genesys_users_get_user_state`](#genesys_users_get_user_state) | Get user state information. |
| [`genesys_users_get_user_station`](#genesys_users_get_user_station) | Get station information for user |
| [`genesys_users_get_user_superiors`](#genesys_users_get_user_superiors) | Get superiors |
| [`genesys_users_get_user_trustors`](#genesys_users_get_user_trustors) | List the organizations that have authorized/trusted the user. |
| [`genesys_users_get_users`](#genesys_users_get_users) | Get the list of available users. |
| [`genesys_users_get_users_me`](#genesys_users_get_users_me) | Get current user details. |
| [`genesys_users_get_users_presences_purecloud_bulk`](#genesys_users_get_users_presences_purecloud_bulk) | Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source |
| [`genesys_users_get_voicemail_search`](#genesys_users_get_voicemail_search) | Search voicemails using the q64 value returned from a previous search |
| [`genesys_users_patch_team`](#genesys_users_patch_team) | Update team |
| [`genesys_users_patch_user`](#genesys_users_patch_user) | Update user |
| [`genesys_users_patch_user_callforwarding`](#genesys_users_patch_user_callforwarding) | Patch a user's CallForwarding |
| [`genesys_users_patch_user_geolocation`](#genesys_users_patch_user_geolocation) | Patch a user's Geolocation |
| [`genesys_users_patch_user_presence`](#genesys_users_patch_user_presence) | Patch a user's Presence |
| [`genesys_users_patch_user_presences_purecloud`](#genesys_users_patch_user_presences_purecloud) | Patch a Genesys Cloud user's presence |
| [`genesys_users_post_documentation_gkn_search`](#genesys_users_post_documentation_gkn_search) | Search gkn documentation |
| [`genesys_users_post_documentation_search`](#genesys_users_post_documentation_search) | Search documentation |
| [`genesys_users_post_group_members`](#genesys_users_post_group_members) | Add members |
| [`genesys_users_post_groups`](#genesys_users_post_groups) | Create a group |
| [`genesys_users_post_groups_search`](#genesys_users_post_groups_search) | Search groups |
| [`genesys_users_post_locations_search`](#genesys_users_post_locations_search) | Search locations |
| [`genesys_users_post_presence_definitions`](#genesys_users_post_presence_definitions) | Create a Presence Definition |
| [`genesys_users_post_presence_sources`](#genesys_users_post_presence_sources) | Create a Presence Source |
| [`genesys_users_post_search`](#genesys_users_post_search) | Search users |
| [`genesys_users_post_search`](#genesys_users_post_search) | Search users |
| [`genesys_users_post_search_suggest`](#genesys_users_post_search_suggest) | Suggest resources. |
| [`genesys_users_post_search_teams_assign`](#genesys_users_post_search_teams_assign) | Search users assigned to teams |
| [`genesys_users_post_speechandtextanalytics_transcripts_search`](#genesys_users_post_speechandtextanalytics_transcripts_search) | Search resources. |
| [`genesys_users_post_team_members`](#genesys_users_post_team_members) | Add team members |
| [`genesys_users_post_teams`](#genesys_users_post_teams) | Create a team |
| [`genesys_users_post_teams_search`](#genesys_users_post_teams_search) | Search resources. |
| [`genesys_users_post_telephony_providers_edges_sites_search`](#genesys_users_post_telephony_providers_edges_sites_search) | Search sites |
| [`genesys_users_post_users`](#genesys_users_post_users) | Create user |
| [`genesys_users_post_users_search`](#genesys_users_post_users_search) | Search users |
| [`genesys_users_post_voicemail_search`](#genesys_users_post_voicemail_search) | Search voicemails |
| [`genesys_users_put_group`](#genesys_users_put_group) | Update group |
| [`genesys_users_put_presence_definition`](#genesys_users_put_presence_definition) | Update a Presence Definition |
| [`genesys_users_put_presence_settings`](#genesys_users_put_presence_settings) | Update the presence settings |
| [`genesys_users_put_presence_source`](#genesys_users_put_presence_source) | Update a Presence Source |
| [`genesys_users_put_presence_user_primarysource`](#genesys_users_put_presence_user_primarysource) | Update a user's Primary Presence Source |
| [`genesys_users_put_stations_me_associatedstation_station_id`](#genesys_users_put_stations_me_associatedstation_station_id) | Set self associated station |
| [`genesys_users_put_user_callforwarding`](#genesys_users_put_user_callforwarding) | Update a user's CallForwarding |
| [`genesys_users_put_user_outofoffice`](#genesys_users_put_user_outofoffice) | Update an OutOfOffice |
| [`genesys_users_put_user_profileskills`](#genesys_users_put_user_profileskills) | Update profile skills for a user |
| [`genesys_users_put_user_roles`](#genesys_users_put_user_roles) | Sets the user's roles |
| [`genesys_users_put_user_routingstatus`](#genesys_users_put_user_routingstatus) | Update the routing status of a user |
| [`genesys_users_put_user_state`](#genesys_users_put_user_state) | Update user state information. |
| [`genesys_users_put_user_station_associatedstation_station_id`](#genesys_users_put_user_station_associatedstation_station_id) | Set associated station |
| [`genesys_users_put_user_station_defaultstation_station_id`](#genesys_users_put_user_station_defaultstation_station_id) | Set default station |
***
## genesys\_users\_delete\_group
Delete group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `groupId` | string | Yes | — | Group ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "Group ID"
}
},
"required": [
"PCID",
"groupId"
]
}
```
***
## genesys\_users\_delete\_group\_members
Remove members
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------- |
| `groupId` | string | Yes | — | Group ID |
| `ids` | string | Yes | — | Comma separated list of userIds to remove. A maximum of 50 members are allowed per request. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "Group ID"
},
"ids": {
"type": "string",
"description": "Comma separated list of userIds to remove. A maximum of 50 members are allowed per request."
}
},
"required": [
"PCID",
"groupId",
"ids"
]
}
```
***
## genesys\_users\_delete\_presence\_definition
Delete a Presence Definition
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------- |
| `definitionId` | string | Yes | — | Presence Definition ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"definitionId": {
"type": "string",
"description": "Presence Definition ID"
}
},
"required": [
"PCID",
"definitionId"
]
}
```
***
## genesys\_users\_delete\_presence\_source
Delete a Presence Source
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------ |
| `sourceId` | string | Yes | — | Presence Source ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sourceId": {
"type": "string",
"description": "Presence Source ID"
}
},
"required": [
"PCID",
"sourceId"
]
}
```
***
## genesys\_users\_delete\_stations\_me\_associatedstation
Clear self associated station
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_delete\_team
Delete team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `teamId` | string | Yes | — | Team ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "string",
"description": "Team ID"
}
},
"required": [
"PCID",
"teamId"
]
}
```
***
## genesys\_users\_delete\_team\_members
Delete team members
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------------------- |
| `teamId` | string | Yes | — | Team ID |
| `id` | string | Yes | — | Comma separated list of member ids to remove |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "string",
"description": "Team ID"
},
"id": {
"type": "string",
"description": "Comma separated list of member ids to remove"
}
},
"required": [
"PCID",
"teamId",
"id"
]
}
```
***
## genesys\_users\_delete\_user
Delete user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_delete\_user\_station\_associatedstation
Clear associated station
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_delete\_user\_station\_defaultstation
Clear default station
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_authorization\_divisionspermitted\_paged\_me
Returns which divisions the current user has the given permission in.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------ |
| `permission` | string | Yes | — | The permission string, including the object to access, e.g. routing:queue:view |
| `pageNumber` | integer | No | — | Page number |
| `pageSize` | integer | No | — | Page size |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"permission": {
"type": "string",
"description": "The permission string, including the object to access, e.g. routing:queue:view"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"pageSize": {
"type": "integer",
"description": "Page size"
}
},
"required": [
"PCID",
"permission"
]
}
```
***
## genesys\_users\_get\_documentation\_gkn\_search
Search gkn documentation using the q64 value returned from a previous search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------- |
| `q64` | string | Yes | — | The q64 value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q64": {
"type": "string",
"description": "The q64 value"
}
},
"required": [
"PCID",
"q64"
]
}
```
***
## genesys\_users\_get\_documentation\_search
Search documentation using the q64 value returned from a previous search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------- |
| `q64` | string | Yes | — | The q64 value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q64": {
"type": "string",
"description": "The q64 value"
}
},
"required": [
"PCID",
"q64"
]
}
```
***
## genesys\_users\_get\_group
Get group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `groupId` | string | Yes | — | Group ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "Group ID"
}
},
"required": [
"PCID",
"groupId"
]
}
```
***
## genesys\_users\_get\_group\_individuals
Get all individuals associated with the group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `groupId` | string | Yes | — | Group ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "Group ID"
}
},
"required": [
"PCID",
"groupId"
]
}
```
***
## genesys\_users\_get\_group\_members
Get group members, includes individuals, owners, and dynamically included people
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | ---------------------------------- |
| `groupId` | string | Yes | — | Group ID |
| `pageSize` | integer | No | — | Page size |
| `pageNumber` | integer | No | — | Page number |
| `sortOrder` | string | No | — | Ascending or descending sort order |
| `expand` | string\[] | No | — | Which fields, if any, to expand |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "Group ID"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"sortOrder": {
"type": "string",
"description": "Ascending or descending sort order",
"enum": [
"ascending",
"descending"
]
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"routingStatus",
"presence",
"integrationPresence",
"conversationSummary",
"outOfOffice",
"geolocation",
"station",
"authorization",
"lasttokenissued",
"authorization.unusedRoles",
"team",
"workPlanBidRanks",
"externalContactsSettings",
"groups",
"customAttributes",
"profileSkills",
"certifications",
"locations",
"skills",
"languages",
"languagePreference",
"employerInfo",
"biography",
"dateLastLogin",
"dateWelcomeSent"
]
},
"description": "Which fields, if any, to expand"
}
},
"required": [
"PCID",
"groupId"
]
}
```
***
## genesys\_users\_get\_groups
Get a group list
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------- |
| `pageSize` | integer | No | — | Page size |
| `pageNumber` | integer | No | — | Page number |
| `id` | string\[] | No | — | The id value |
| `jabberId` | string\[] | No | — | A list of jabberIds to fetch by bulk (cannot be used with the "id" parameter) |
| `sortOrder` | string | No | — | Ascending or descending sort order |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"id": {
"type": "array",
"items": {
"type": "string"
},
"description": "The id value"
},
"jabberId": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)"
},
"sortOrder": {
"type": "string",
"description": "Ascending or descending sort order",
"enum": [
"ascending",
"descending"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_get\_groups\_search
Search groups using the q64 value returned from a previous search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ---------------------------------- |
| `q64` | string | Yes | — | The q64 value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q64": {
"type": "string",
"description": "The q64 value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"q64"
]
}
```
***
## genesys\_users\_get\_locations\_search
Search locations using the q64 value returned from a previous search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ------------------------------------------------ |
| `q64` | string | Yes | — | The q64 value |
| `expand` | string\[] | No | — | Provides more details about a specified resource |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q64": {
"type": "string",
"description": "The q64 value"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"images",
"addressVerificationDetails"
]
},
"description": "Provides more details about a specified resource"
}
},
"required": [
"PCID",
"q64"
]
}
```
***
## genesys\_users\_get\_me
Get current user details.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `expand` | string\[] | No | — | Which fields, if any, to expand. |
| `integrationPresenceSource` | string | No | — | Get your presence for a given integration. This parameter will only be used when presence is provided as an "expand". |
| `userCustomAttributeSchemaIds` | string\[] | No | — | Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an "expand". The maximum number of schemaIds that can be requested is 100 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"routingStatus",
"presence",
"integrationPresence",
"conversationSummary",
"outOfOffice",
"geolocation",
"station",
"authorization",
"lasttokenissued",
"authorization.unusedRoles",
"team",
"workPlanBidRanks",
"externalContactsSettings",
"groups",
"customAttributes",
"profileSkills",
"certifications",
"locations",
"skills",
"languages",
"languagePreference",
"employerInfo",
"biography",
"dateLastLogin",
"dateWelcomeSent",
"date",
"geolocationsettings",
"organization",
"presencedefinitions",
"divisionedpresencedefinitions",
"locationdefinitions",
"orgauthorization",
"orgproducts",
"favorites",
"superiors",
"directreports",
"adjacents",
"routingskills",
"routinglanguages",
"fieldconfigs",
"token",
"trustors",
"logCapture",
"autoanswersettings"
]
},
"description": "Which fields, if any, to expand."
},
"integrationPresenceSource": {
"type": "string",
"description": "Get your presence for a given integration. This parameter will only be used when presence is provided as an \"expand\".",
"enum": [
"MicrosoftTeams",
"ZoomPhone",
"EightByEight"
]
},
"userCustomAttributeSchemaIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an \"expand\". The maximum number of schemaIds that can be requested is 100"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_get\_presence\_definition
Get a Presence Definition
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------- |
| `definitionId` | string | Yes | — | Presence Definition ID |
| `localeCode` | string | No | — | The locale code to fetch for the presence definition. Use ALL to fetch everything. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"definitionId": {
"type": "string",
"description": "Presence Definition ID"
},
"localeCode": {
"type": "string",
"description": "The locale code to fetch for the presence definition. Use ALL to fetch everything.",
"enum": [
"ALL",
"he",
"fr",
"en_US",
"da",
"de",
"it",
"cs",
"es",
"fi",
"ar",
"ja",
"ko",
"nl",
"no",
"pl",
"pt_BR",
"pt_PT",
"ru",
"sv",
"th",
"tr",
"uk",
"zh_CN",
"zh_TW"
]
}
},
"required": [
"PCID",
"definitionId"
]
}
```
***
## genesys\_users\_get\_presence\_definitions
Get a list of Presence Definitions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `deactivated` | string | No | — | Deactivated query can be TRUE or FALSE |
| `divisionId` | string\[] | No | — | One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned. |
| `localeCode` | string | No | — | The locale code to fetch for the presence definition. Use ALL to fetch everything. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deactivated": {
"type": "string",
"description": "Deactivated query can be TRUE or FALSE"
},
"divisionId": {
"type": "array",
"items": {
"type": "string"
},
"description": "One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned."
},
"localeCode": {
"type": "string",
"description": "The locale code to fetch for the presence definition. Use ALL to fetch everything.",
"enum": [
"ALL",
"he",
"fr",
"en_US",
"da",
"de",
"it",
"cs",
"es",
"fi",
"ar",
"ja",
"ko",
"nl",
"no",
"pl",
"pt_BR",
"pt_PT",
"ru",
"sv",
"th",
"tr",
"uk",
"zh_CN",
"zh_TW"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_get\_presence\_settings
Get the presence settings
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_get\_presence\_source
Get a Presence Source
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------ |
| `sourceId` | string | Yes | — | Presence Source ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sourceId": {
"type": "string",
"description": "Presence Source ID"
}
},
"required": [
"PCID",
"sourceId"
]
}
```
***
## genesys\_users\_get\_presence\_sources
Get a list of Presence Sources
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | -------------------------------------- |
| `deactivated` | string | No | — | Deactivated query can be TRUE or FALSE |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deactivated": {
"type": "string",
"description": "Deactivated query can be TRUE or FALSE"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_get\_presence\_user\_primarysource
Get a user's Primary Presence Source
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | user ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "user ID"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_query
Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is required
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | Cursor token to retrieve next page |
| `pageSize` | integer | No | — | Page size |
| `sortOrder` | string | No | — | Ascending or descending sort order |
| `expand` | string\[] | No | — | Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead. |
| `integrationPresenceSource` | string | No | — | Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an "expand". When using this parameter the maximum number of users that can be returned is 100. |
| `userCustomAttributeSchemaIds` | string\[] | No | — | Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an "expand". The maximum number of schemaIds that can be requested is 5 |
| `state` | string | No | — | Only list users of this state |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "Cursor token to retrieve next page"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"sortOrder": {
"type": "string",
"description": "Ascending or descending sort order",
"enum": [
"ASC",
"DESC"
]
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"routingStatus",
"presence",
"integrationPresence",
"conversationSummary",
"outOfOffice",
"geolocation",
"station",
"authorization",
"lasttokenissued",
"authorization.unusedRoles",
"team",
"workPlanBidRanks",
"externalContactsSettings",
"groups",
"customAttributes",
"profileSkills",
"certifications",
"locations",
"skills",
"languages",
"languagePreference",
"employerInfo",
"biography",
"dateLastLogin",
"dateWelcomeSent"
]
},
"description": "Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead."
},
"integrationPresenceSource": {
"type": "string",
"description": "Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100.",
"enum": [
"MicrosoftTeams",
"ZoomPhone",
"EightByEight"
]
},
"userCustomAttributeSchemaIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an \"expand\". The maximum number of schemaIds that can be requested is 5"
},
"state": {
"type": "string",
"description": "Only list users of this state",
"enum": [
"active",
"inactive",
"deleted",
"any"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_get\_search
Search users using the q64 value returned from a previous search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | ------ | -------- | ------- | ------------------------- |
| `q64` | string | Yes | — | q64 |
| `expand` | any\[] | No | — | expand |
| `integrationPresenceSource` | string | No | — | integrationPresenceSource |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q64": {
"type": "string",
"description": "q64"
},
"expand": {
"type": "array",
"description": "expand"
},
"integrationPresenceSource": {
"type": "string",
"description": "integrationPresenceSource",
"enum": [
"MicrosoftTeams",
"ZoomPhone",
"EightByEight"
]
}
},
"required": [
"PCID",
"q64"
]
}
```
***
## genesys\_users\_get\_search
Search users using the q64 value returned from a previous search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | --------- | -------- | ------- | ---------------------------------- |
| `q64` | string | Yes | — | The q64 value |
| `expand` | string\[] | No | — | Related resources to expand inline |
| `integrationPresenceSource` | string | No | — | Integration Presence Source |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q64": {
"type": "string",
"description": "The q64 value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"integrationPresenceSource": {
"type": "string",
"description": "Integration Presence Source",
"enum": [
"MicrosoftTeams",
"ZoomPhone",
"EightByEight"
]
}
},
"required": [
"PCID",
"q64"
]
}
```
***
## genesys\_users\_get\_search\_suggest
Suggest resources using the q64 value returned from a previous suggest query.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ------------------------------- |
| `q64` | string | Yes | — | The q64 value |
| `expand` | string\[] | No | — | Which fields, if any, to expand |
| `profile` | boolean | No | — | The profile value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q64": {
"type": "string",
"description": "The q64 value"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"routingStatus",
"presence",
"integrationPresence",
"conversationSummary",
"outOfOffice",
"geolocation",
"station",
"authorization",
"lasttokenissued",
"authorization.unusedRoles",
"team",
"workPlanBidRanks",
"externalContactsSettings",
"groups",
"customAttributes",
"profileSkills",
"certifications",
"locations",
"skills",
"languages",
"languagePreference",
"employerInfo",
"biography",
"dateLastLogin",
"dateWelcomeSent",
"callerUser.routingStatus",
"callerUser.primaryPresence",
"callerUser.conversationSummary",
"callerUser.outOfOffice",
"callerUser.geolocation",
"conversations",
"transcription",
"images",
"addressVerificationDetails"
]
},
"description": "Which fields, if any, to expand"
},
"profile": {
"type": "boolean",
"description": "The profile value"
}
},
"required": [
"PCID",
"q64"
]
}
```
***
## genesys\_users\_get\_stations\_me
Get station information for self
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_get\_systempresences
Get the list of SystemPresences
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_get\_team
Get team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------ |
| `teamId` | string | Yes | — | Team ID |
| `expand` | string | No | — | Expand the division name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "string",
"description": "Team ID"
},
"expand": {
"type": "string",
"description": "Expand the division name",
"enum": [
"entities.division"
]
}
},
"required": [
"PCID",
"teamId"
]
}
```
***
## genesys\_users\_get\_team\_members
Get team membership
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------- |
| `teamId` | string | Yes | — | Team ID |
| `pageSize` | integer | No | — | Page size |
| `before` | string | No | — | The cursor that points to the previous item in the complete list of teams |
| `after` | string | No | — | The cursor that points to the next item in the complete list of teams |
| `expand` | string | No | — | Expand the name on each user |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "string",
"description": "Team ID"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"before": {
"type": "string",
"description": "The cursor that points to the previous item in the complete list of teams"
},
"after": {
"type": "string",
"description": "The cursor that points to the next item in the complete list of teams"
},
"expand": {
"type": "string",
"description": "Expand the name on each user",
"enum": [
"entities"
]
}
},
"required": [
"PCID",
"teamId"
]
}
```
***
## genesys\_users\_get\_teams
Get Team listing
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------- |
| `pageSize` | integer | No | — | Page size |
| `name` | string | No | — | Return only teams whose names start with this value (case-insensitive matching) |
| `after` | string | No | — | The cursor that points to the next item in the complete list of teams |
| `before` | string | No | — | The cursor that points to the previous item in the complete list of teams |
| `expand` | string | No | — | Expand the division on each team |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"name": {
"type": "string",
"description": "Return only teams whose names start with this value (case-insensitive matching)"
},
"after": {
"type": "string",
"description": "The cursor that points to the next item in the complete list of teams"
},
"before": {
"type": "string",
"description": "The cursor that points to the previous item in the complete list of teams"
},
"expand": {
"type": "string",
"description": "Expand the division on each team",
"enum": [
"entities.division"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_get\_telephony\_providers\_edges\_sites\_search
Search sites using the q64 value returned from a previous search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ---------------------------------- |
| `q64` | string | Yes | — | The q64 value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q64": {
"type": "string",
"description": "The q64 value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"q64"
]
}
```
***
## genesys\_users\_get\_user
Get user.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | User ID |
| `expand` | string\[] | No | — | Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead. |
| `integrationPresenceSource` | string | No | — | Gets an integration presence for a user instead of their default. |
| `userCustomAttributeSchemaIds` | string\[] | No | — | Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an "expand". The maximum number of schemaIds that can be requested is 100 |
| `state` | string | No | — | Search for a user with this state |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"routingStatus",
"presence",
"integrationPresence",
"conversationSummary",
"outOfOffice",
"geolocation",
"station",
"authorization",
"lasttokenissued",
"authorization.unusedRoles",
"team",
"workPlanBidRanks",
"externalContactsSettings",
"groups",
"customAttributes",
"profileSkills",
"certifications",
"locations",
"skills",
"languages",
"languagePreference",
"employerInfo",
"biography",
"dateLastLogin",
"dateWelcomeSent"
]
},
"description": "Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead."
},
"integrationPresenceSource": {
"type": "string",
"description": "Gets an integration presence for a user instead of their default.",
"enum": [
"MicrosoftTeams",
"ZoomPhone",
"EightByEight"
]
},
"userCustomAttributeSchemaIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an \"expand\". The maximum number of schemaIds that can be requested is 100"
},
"state": {
"type": "string",
"description": "Search for a user with this state",
"enum": [
"active",
"deleted"
]
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_user\_callforwarding
Get a user's CallForwarding
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_user\_directreports
Get direct reports
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ------------------------------- |
| `userId` | string | Yes | — | User ID |
| `expand` | string\[] | No | — | Which fields, if any, to expand |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"routingStatus",
"presence",
"integrationPresence",
"conversationSummary",
"outOfOffice",
"geolocation",
"station",
"authorization",
"lasttokenissued",
"authorization.unusedRoles",
"team",
"workPlanBidRanks",
"externalContactsSettings",
"groups",
"customAttributes",
"profileSkills",
"certifications",
"locations",
"skills",
"languages",
"languagePreference",
"employerInfo",
"biography",
"dateLastLogin",
"dateWelcomeSent"
]
},
"description": "Which fields, if any, to expand"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_user\_geolocation
Get a user's Geolocation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | user Id |
| `clientId` | string | Yes | — | client Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "user Id"
},
"clientId": {
"type": "string",
"description": "client Id"
}
},
"required": [
"PCID",
"userId",
"clientId"
]
}
```
***
## genesys\_users\_get\_user\_outofoffice
Get a OutOfOffice
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_user\_presence
Get a user's Presence
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------ |
| `userId` | string | Yes | — | user Id |
| `sourceId` | string | Yes | — | Presence source ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "user Id"
},
"sourceId": {
"type": "string",
"description": "Presence source ID"
}
},
"required": [
"PCID",
"userId",
"sourceId"
]
}
```
***
## genesys\_users\_get\_user\_presences\_purecloud
Get a user's Genesys Cloud presence.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | user Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "user Id"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_user\_profileskills
List profile skills for a user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_user\_queues
Get queues for user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ---------------------- |
| `userId` | string | Yes | — | User ID |
| `pageSize` | integer | No | — | Page size |
| `pageNumber` | integer | No | — | Page number |
| `joined` | boolean | No | — | Is joined to the queue |
| `divisionId` | any\[] | No | — | Division ID(s) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"joined": {
"type": "boolean",
"description": "Is joined to the queue"
},
"divisionId": {
"type": "array",
"description": "Division ID(s)"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_user\_roles
Returns a listing of roles and permissions for a user.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `subjectId` | string | Yes | — | User ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"subjectId": {
"type": "string",
"description": "User ID"
}
},
"required": [
"PCID",
"subjectId"
]
}
```
***
## genesys\_users\_get\_user\_routinglanguages
List routing languages assigned to a user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ---------------------------------- |
| `userId` | string | Yes | — | User ID |
| `pageSize` | integer | No | — | Page size |
| `pageNumber` | integer | No | — | Page number |
| `sortOrder` | string | No | — | Ascending or descending sort order |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"sortOrder": {
"type": "string",
"description": "Ascending or descending sort order",
"enum": [
"ascending",
"descending"
]
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_user\_routingskills
List routing skills assigned to a user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ---------------------------------- |
| `userId` | string | Yes | — | User ID |
| `pageSize` | integer | No | — | Page size |
| `pageNumber` | integer | No | — | Page number |
| `sortOrder` | string | No | — | Ascending or descending sort order |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"sortOrder": {
"type": "string",
"description": "Ascending or descending sort order",
"enum": [
"ascending",
"descending"
]
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_user\_routingstatus
Fetch the routing status of a user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_user\_state
Get user state information.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_user\_station
Get station information for user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_user\_superiors
Get superiors
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ------------------------------- |
| `userId` | string | Yes | — | User ID |
| `expand` | string\[] | No | — | Which fields, if any, to expand |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"routingStatus",
"presence",
"integrationPresence",
"conversationSummary",
"outOfOffice",
"geolocation",
"station",
"authorization",
"lasttokenissued",
"authorization.unusedRoles",
"team",
"workPlanBidRanks",
"externalContactsSettings",
"groups",
"customAttributes",
"profileSkills",
"certifications",
"locations",
"skills",
"languages",
"languagePreference",
"employerInfo",
"biography",
"dateLastLogin",
"dateWelcomeSent"
]
},
"description": "Which fields, if any, to expand"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_user\_trustors
List the organizations that have authorized/trusted the user.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User ID |
| `pageSize` | integer | No | — | Page size |
| `pageNumber` | integer | No | — | Page number |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_get\_users
Get the list of available users.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pageSize` | integer | No | — | Page size |
| `pageNumber` | integer | No | — | Page number |
| `id` | string\[] | No | — | A list of user IDs to fetch by bulk |
| `jabberId` | string\[] | No | — | A list of jabberIds to fetch by bulk (cannot be used with the "id" parameter) |
| `sortOrder` | string | No | — | Ascending or descending sort order |
| `expand` | string\[] | No | — | Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead. |
| `integrationPresenceSource` | string | No | — | Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an "expand". When using this parameter the maximum number of users that can be returned is 100. |
| `userCustomAttributeSchemaIds` | string\[] | No | — | Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an "expand". The maximum number of schemaIds that can be requested is 5 |
| `state` | string | No | — | Only list users of this state |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"id": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of user IDs to fetch by bulk"
},
"jabberId": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)"
},
"sortOrder": {
"type": "string",
"description": "Ascending or descending sort order",
"enum": [
"ascending",
"descending"
]
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"routingStatus",
"presence",
"integrationPresence",
"conversationSummary",
"outOfOffice",
"geolocation",
"station",
"authorization",
"lasttokenissued",
"authorization.unusedRoles",
"team",
"workPlanBidRanks",
"externalContactsSettings",
"groups",
"customAttributes",
"profileSkills",
"certifications",
"locations",
"skills",
"languages",
"languagePreference",
"employerInfo",
"biography",
"dateLastLogin",
"dateWelcomeSent"
]
},
"description": "Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead."
},
"integrationPresenceSource": {
"type": "string",
"description": "Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100.",
"enum": [
"MicrosoftTeams",
"ZoomPhone",
"EightByEight"
]
},
"userCustomAttributeSchemaIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an \"expand\". The maximum number of schemaIds that can be requested is 5"
},
"state": {
"type": "string",
"description": "Only list users of this state",
"enum": [
"active",
"inactive",
"deleted",
"any"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_get\_users\_me
Get current user details.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------- |
| `expand` | any\[] | No | — | Which fields, if any, to expand. |
| `integrationPresenceSource` | string | No | — | Get your presence for a given integration. This parameter will only be used when presence is provided as an "expand". |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "array",
"description": "Which fields, if any, to expand."
},
"integrationPresenceSource": {
"type": "string",
"description": "Get your presence for a given integration. This parameter will only be used when presence is provided as an \"expand\".",
"enum": [
"MicrosoftTeams",
"ZoomPhone",
"EightByEight"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_get\_users\_presences\_purecloud\_bulk
Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------ |
| `id` | any\[] | No | — | A comma separated list of user IDs to fetch their presence status in bulk. Limit 50. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "array",
"description": "A comma separated list of user IDs to fetch their presence status in bulk. Limit 50."
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_get\_voicemail\_search
Search voicemails using the q64 value returned from a previous search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ---------------------------------- |
| `q64` | string | Yes | — | The q64 value |
| `expand` | string\[] | No | — | Related resources to expand inline |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q64": {
"type": "string",
"description": "The q64 value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"q64"
]
}
```
***
## genesys\_users\_patch\_team
Update team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- |
| `teamId` | string | Yes | — | Team ID |
| `dateCreated` | string | No | — | Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateModified` | string | No | — | Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `description` | string | No | — | Team information. |
| `division` | object | No | — | The division value |
| `id` | string | No | — | The globally unique identifier for the object. |
| `memberCount` | integer | No | — | Number of members in a team |
| `name` | string | Yes | — | The team name |
| `selfUri` | string | No | — | The URI for this object |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "string",
"description": "Team ID"
},
"dateCreated": {
"type": "string",
"description": "Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"description": {
"type": "string",
"description": "Team information."
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"memberCount": {
"type": "integer",
"description": "Number of members in a team"
},
"name": {
"type": "string",
"description": "The team name"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"teamId",
"name"
]
}
```
***
## genesys\_users\_patch\_user
Update user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | User ID |
| `acdAutoAnswer` | boolean | No | — | The value that denotes if acdAutoAnswer is set on the user |
| `addresses` | object\[] | No | — | Email address, phone number, and/or extension for this user. One entry is allowed per media type |
| `biography` | object | No | — | The biography value |
| `certifications` | string\[] | No | — | The certifications value |
| `chat` | object | No | — | The chat value |
| `department` | string | No | — | The department value |
| `email` | string | No | — | The email value |
| `employerInfo` | object | No | — | Employer Info |
| `groups` | object\[] | No | — | The groups the user is a member of |
| `id` | string | No | — | The globally unique identifier for the object. |
| `images` | object\[] | No | — | The images value |
| `locations` | object\[] | No | — | The user placement at each site location. |
| `manager` | string | No | — | The manager value |
| `name` | string | No | — | The name value |
| `preferredName` | string | No | — | Preferred full name of agent |
| `primaryContactInfo` | object\[] | No | — | The address(s) used for primary contact. Updates to the corresponding address in the addresses list will be reflected here. |
| `profileSkills` | string\[] | No | — | Profile skills possessed by the user |
| `selfUri` | string | No | — | The URI for this object |
| `state` | string | No | — | The state of the user. This property can be used to restore a deleted user or transition between active and inactive. If specified, it is the only modifiable field. |
| `title` | string | No | — | The title value |
| `username` | string | No | — | The username value |
| `version` | integer | Yes | — | This value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "The value that denotes if acdAutoAnswer is set on the user"
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Email address or phone number for this contact type"
},
"display": {
"type": "string",
"description": "Formatted version of the address property"
},
"mediaType": {
"type": "string",
"enum": [
"PHONE",
"EMAIL",
"SMS"
],
"description": "Media Type"
},
"type": {
"type": "string",
"enum": [
"PRIMARY",
"WORK",
"WORK2",
"WORK3",
"WORK4",
"HOME",
"MOBILE",
"MAIN",
"OTHER"
],
"description": "The type value"
},
"extension": {
"type": "string",
"description": "Use internal extension instead of address. Mutually exclusive with the address field."
},
"countryCode": {
"type": "string",
"description": "Country Code"
},
"integration": {
"type": "string",
"description": "Integration tag value if this number is associated with an external integration."
}
}
},
"description": "Email address, phone number, and/or extension for this user. One entry is allowed per media type"
},
"biography": {
"type": "object",
"description": "The biography value",
"properties": {
"biography": {
"type": "string",
"description": "Personal detailed description"
},
"interests": {
"type": "array",
"items": {
"type": "string"
},
"description": "The interests value"
},
"hobbies": {
"type": "array",
"items": {
"type": "string"
},
"description": "The hobbies value"
},
"spouse": {
"type": "string",
"description": "The spouse value"
},
"education": {
"type": "array",
"items": {
"type": "object"
},
"description": "User education details"
}
}
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"chat": {
"type": "object",
"description": "The chat value",
"properties": {
"jabberId": {
"type": "string",
"description": "Jabber Id"
}
}
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info",
"properties": {
"officialName": {
"type": "string",
"description": "Official Name"
},
"employeeId": {
"type": "string",
"description": "Employee Id"
},
"employeeType": {
"type": "string",
"description": "Employee Type"
},
"dateHire": {
"type": "string",
"description": "Date Hire"
}
}
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The group name."
},
"description": {
"type": "string",
"description": "The description value"
},
"dateModified": {
"type": "string",
"format": "date-time",
"description": "Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"memberCount": {
"type": "integer",
"format": "int64",
"description": "Number of members."
},
"state": {
"type": "string",
"enum": [
"active",
"inactive",
"deleted"
],
"description": "Active, inactive, or deleted state."
},
"version": {
"type": "integer",
"format": "int32",
"description": "Current version for this resource."
},
"type": {
"type": "string",
"enum": [
"official",
"social"
],
"description": "Type of group."
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resolution": {
"type": "string",
"description": "Height and/or width of image. ex: 640x480 or x128"
},
"imageUri": {
"type": "string"
}
}
},
"description": "The images value"
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Phone number for this contact type"
},
"extension": {
"type": "string",
"description": "Extension is set if the number is e164 valid"
},
"display": {
"type": "string",
"description": "Formatted version of the address property"
},
"type": {
"type": "string",
"description": "Contact type of the address"
},
"mediaType": {
"type": "string",
"description": "Media type of the address"
}
}
},
"description": "The addresses value"
},
"rulesVisible": {
"type": "boolean",
"description": "Are membership rules visible to the person requesting to view the group"
},
"visibility": {
"type": "string",
"enum": [
"public",
"owners",
"members"
],
"description": "Who can view this group"
},
"rolesEnabled": {
"type": "boolean",
"description": "Allow roles to be assigned to this group"
},
"includeOwners": {
"type": "boolean",
"description": "Allow owners to be included as members of the group"
},
"callsEnabled": {
"type": "boolean",
"description": "Allow calls to be placed to this group."
},
"owners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string"
},
"division": {
"type": "object"
},
"chat": {
"type": "object"
},
"department": {
"type": "string"
},
"email": {
"type": "string"
},
"primaryContactInfo": {
"type": "array",
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user."
},
"title": {
"type": "string"
},
"username": {
"type": "string"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array"
},
"biography": {
"type": "object"
},
"employerInfo": {
"type": "object"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object"
},
"presence": {
"type": "object"
},
"integrationPresence": {
"type": "object"
},
"conversationSummary": {
"type": "object"
},
"outOfOffice": {
"type": "object"
},
"geolocation": {
"type": "object"
},
"station": {
"type": "object"
},
"authorization": {
"type": "object"
},
"profileSkills": {
"type": "array",
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"description": "The groups the user is a member of"
},
"team": {
"type": "object"
},
"workPlanBidRanks": {
"type": "object"
},
"skills": {
"type": "array",
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"description": "Owners of the group"
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "The URI for this object"
}
},
"required": [
"name",
"rulesVisible",
"type",
"visibility"
]
},
"description": "The groups the user is a member of"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resolution": {
"type": "string",
"description": "Height and/or width of image. ex: 640x480 or x128"
},
"imageUri": {
"type": "string",
"description": "Image Uri"
}
}
},
"description": "The images value"
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the location"
},
"floorplanId": {
"type": "string",
"description": "Unique identifier for the location floorplan image"
},
"coordinates": {
"type": "object",
"description": "Users coordinates on the floorplan. Only used when floorplanImage is set"
},
"notes": {
"type": "string",
"description": "Optional description on the users location"
},
"locationDefinition": {
"type": "object",
"description": "Location Definition"
}
}
},
"description": "The user placement at each site location."
},
"manager": {
"type": "string",
"description": "The manager value"
},
"name": {
"type": "string",
"description": "The name value"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of agent"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Email address or phone number for this contact type"
},
"display": {
"type": "string",
"description": "Formatted version of the address property"
},
"mediaType": {
"type": "string",
"enum": [
"PHONE",
"EMAIL",
"SMS"
],
"description": "Media Type"
},
"type": {
"type": "string",
"enum": [
"PRIMARY",
"WORK",
"WORK2",
"WORK3",
"WORK4",
"HOME",
"MOBILE",
"MAIN",
"OTHER"
],
"description": "The type value"
},
"extension": {
"type": "string",
"description": "Use internal extension instead of address. Mutually exclusive with the address field."
},
"countryCode": {
"type": "string",
"description": "Country Code"
},
"integration": {
"type": "string",
"description": "Integration tag value if this number is associated with an external integration."
}
}
},
"description": "The address(s) used for primary contact. Updates to the corresponding address in the addresses list will be reflected here."
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"state": {
"type": "string",
"description": "The state of the user. This property can be used to restore a deleted user or transition between active and inactive. If specified, it is the only modifiable field.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"version": {
"type": "integer",
"description": "This value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
}
},
"required": [
"PCID",
"userId",
"version"
]
}
```
***
## genesys\_users\_patch\_user\_callforwarding
Patch a user's CallForwarding
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | User ID |
| `calls` | object\[] | No | — | An ordered list of CallRoutes to be executed when CallForwarding is enabled |
| `enabled` | boolean | No | — | Whether or not CallForwarding is enabled |
| `id` | string | No | — | The globally unique identifier for the object. |
| `modifiedDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `name` | string | No | — | The name value |
| `phoneNumber` | string | No | — | This property is deprecated. Please use the calls property |
| `selfUri` | string | No | — | The URI for this object |
| `user` | object | No | — | The user value |
| `voicemail` | string | No | — | The type of voicemail to use with the callForwarding configuration |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"calls": {
"type": "array",
"items": {
"type": "object",
"properties": {
"targets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of call"
},
"value": {
"type": "string",
"description": "The id of the station or an E.164 formatted phone number"
}
}
},
"description": "A list of CallTargets to be called when the CallRoute is executed"
}
}
},
"description": "An ordered list of CallRoutes to be executed when CallForwarding is enabled"
},
"enabled": {
"type": "boolean",
"description": "Whether or not CallForwarding is enabled"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"modifiedDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"name": {
"type": "string",
"description": "The name value"
},
"phoneNumber": {
"type": "string",
"description": "This property is deprecated. Please use the calls property"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"user": {
"type": "object",
"description": "The user value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
},
"voicemail": {
"type": "string",
"description": "The type of voicemail to use with the callForwarding configuration",
"enum": [
"PURECLOUD",
"LASTCALL",
"NONE"
]
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_patch\_user\_geolocation
Patch a user's Geolocation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | user Id |
| `clientId` | string | Yes | — | client Id |
| `city` | string | No | — | The city value |
| `country` | string | No | — | The country value |
| `id` | string | No | — | The globally unique identifier for the object. |
| `latitude` | number | No | — | The latitude value |
| `locations` | object\[] | No | — | The locations value |
| `longitude` | number | No | — | The longitude value |
| `name` | string | No | — | The name value |
| `primary` | boolean | No | — | A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH |
| `region` | string | No | — | The region value |
| `selfUri` | string | No | — | The URI for this object |
| `type` | string | No | — | A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "user Id"
},
"clientId": {
"type": "string",
"description": "client Id"
},
"city": {
"type": "string",
"description": "The city value"
},
"country": {
"type": "string",
"description": "The country value"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"latitude": {
"type": "number",
"description": "The latitude value"
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"contactUser": {
"type": "object",
"description": "Contact User"
},
"emergencyNumber": {
"type": "object",
"description": "Emergency Number"
},
"address": {
"type": "object",
"description": "The address value"
},
"state": {
"type": "string",
"enum": [
"active",
"deleted"
],
"description": "Current state of the location entity"
},
"notes": {
"type": "string",
"description": "Notes for the location entity"
},
"version": {
"type": "integer",
"format": "int32",
"description": "Current version of the location entity, value to be supplied should be retrieved by a GET or on create/update response"
},
"path": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of ancestor IDs in order"
},
"profileImage": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resolution": {
"type": "string",
"description": "Height and/or width of image. ex: 640x480 or x128"
},
"imageUri": {
"type": "string"
}
}
},
"description": "Profile image of the location entity, retrieved with ?expand=images query parameter"
},
"floorplanImage": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resolution": {
"type": "string",
"description": "Height and/or width of image. ex: 640x480 or x128"
},
"imageUri": {
"type": "string"
}
}
},
"description": "Floorplan images of the location entity, retrieved with ?expand=images query parameter"
},
"addressVerificationDetails": {
"type": "object",
"description": "Address Verification Details"
},
"addressVerified": {
"type": "boolean",
"description": "Boolean field which states if the address has been verified as an actual address"
},
"addressStored": {
"type": "boolean",
"description": "Boolean field which states if the address has been stored for E911"
},
"images": {
"type": "string",
"description": "The images value"
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "The URI for this object"
}
}
},
"description": "The locations value"
},
"longitude": {
"type": "number",
"description": "The longitude value"
},
"name": {
"type": "string",
"description": "The name value"
},
"primary": {
"type": "boolean",
"description": "A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH"
},
"region": {
"type": "string",
"description": "The region value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"type": {
"type": "string",
"description": "A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc."
}
},
"required": [
"PCID",
"userId",
"clientId"
]
}
```
***
## genesys\_users\_patch\_user\_presence
Patch a user's Presence
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | user Id |
| `sourceId` | string | Yes | — | Presence source ID |
| `futurePresenceDefinition` | object | No | — | Future Presence Definition |
| `id` | string | No | — | The globally unique identifier for the object. |
| `message` | string | No | — | The message value |
| `modifiedDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `name` | string | No | — | The name value |
| `presenceDefinition` | object | No | — | Presence Definition |
| `primary` | boolean | No | — | A boolean used to tell whether or not to set this presence source as the primary on a PATCH |
| `selfUri` | string | No | — | The URI for this object |
| `source` | string | No | — | Deprecated - The sourceID field should be used as a replacement. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "user Id"
},
"sourceId": {
"type": "string",
"description": "Presence source ID"
},
"futurePresenceDefinition": {
"type": "object",
"description": "Future Presence Definition",
"properties": {
"id": {
"type": "string",
"description": "description"
},
"systemPresence": {
"type": "string",
"description": "System Presence"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"message": {
"type": "string",
"description": "The message value"
},
"modifiedDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"name": {
"type": "string",
"description": "The name value"
},
"presenceDefinition": {
"type": "object",
"description": "Presence Definition",
"properties": {
"id": {
"type": "string",
"description": "description"
},
"systemPresence": {
"type": "string",
"description": "System Presence"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"primary": {
"type": "boolean",
"description": "A boolean used to tell whether or not to set this presence source as the primary on a PATCH"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"source": {
"type": "string",
"description": "Deprecated - The sourceID field should be used as a replacement."
}
},
"required": [
"PCID",
"userId",
"sourceId"
]
}
```
***
## genesys\_users\_patch\_user\_presences\_purecloud
Patch a Genesys Cloud user's presence
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | user Id |
| `futurePresenceDefinition` | object | No | — | Future Presence Definition |
| `id` | string | No | — | The globally unique identifier for the object. |
| `message` | string | No | — | The message value |
| `modifiedDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `name` | string | No | — | The name value |
| `presenceDefinition` | object | No | — | Presence Definition |
| `primary` | boolean | No | — | A boolean used to tell whether or not to set this presence source as the primary on a PATCH |
| `selfUri` | string | No | — | The URI for this object |
| `source` | string | No | — | Deprecated - The sourceID field should be used as a replacement. |
| `sourceId` | string | No | — | Represents the ID of a registered source |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "user Id"
},
"futurePresenceDefinition": {
"type": "object",
"description": "Future Presence Definition",
"properties": {
"id": {
"type": "string",
"description": "description"
},
"systemPresence": {
"type": "string",
"description": "System Presence"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"message": {
"type": "string",
"description": "The message value"
},
"modifiedDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"name": {
"type": "string",
"description": "The name value"
},
"presenceDefinition": {
"type": "object",
"description": "Presence Definition",
"properties": {
"id": {
"type": "string",
"description": "description"
},
"systemPresence": {
"type": "string",
"description": "System Presence"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"primary": {
"type": "boolean",
"description": "A boolean used to tell whether or not to set this presence source as the primary on a PATCH"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"source": {
"type": "string",
"description": "Deprecated - The sourceID field should be used as a replacement."
},
"sourceId": {
"type": "string",
"description": "Represents the ID of a registered source"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_post\_documentation\_gkn\_search
Search gkn documentation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | -------------------------------------------------------------- |
| `pageNumber` | integer | No | — | The page of resources you want to retrieve |
| `pageSize` | integer | No | — | The number of results per page |
| `query` | object\[] | No | — | Search query string |
| `sort` | object\[] | No | — | Multi-value sort order, list of multiple sort values |
| `sortBy` | string | No | — | The field in the resource that you want to sort the results by |
| `sortOrder` | string | No | — | The sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "The page of resources you want to retrieve"
},
"pageSize": {
"type": "integer",
"description": "The number of results per page"
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endValue": {
"type": "string",
"description": "The end value of the range. This field is used for range search types."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values for the search to match against"
},
"startValue": {
"type": "string",
"description": "The start value of the range. This field is used for range search types."
},
"value": {
"type": "string",
"description": "A value for the search to match against"
},
"operator": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT"
],
"description": "How to apply this search criteria against other criteria"
},
"group": {
"type": "array",
"items": {
"type": "object"
},
"description": "Groups multiple conditions"
},
"dateFormat": {
"type": "string",
"description": "Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."
},
"type": {
"type": "string",
"enum": [
"SIMPLE"
],
"description": "Search Type"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Field names to search against"
}
},
"required": [
"type"
]
},
"description": "Search query string"
},
"sort": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sortOrder": {
"type": "string",
"enum": [
"ASC",
"DESC",
"SCORE"
],
"description": "The sort order for results"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
}
}
},
"description": "Multi-value sort order, list of multiple sort values"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
},
"sortOrder": {
"type": "string",
"description": "The sort order for results",
"enum": [
"ASC",
"DESC",
"SCORE"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_post\_documentation\_search
Search documentation
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | -------------------------------------------------------------- |
| `pageNumber` | integer | No | — | The page of resources you want to retrieve |
| `pageSize` | integer | No | — | The number of results per page |
| `query` | object\[] | No | — | Search query string |
| `sort` | object\[] | No | — | Multi-value sort order, list of multiple sort values |
| `sortBy` | string | No | — | The field in the resource that you want to sort the results by |
| `sortOrder` | string | No | — | The sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "The page of resources you want to retrieve"
},
"pageSize": {
"type": "integer",
"description": "The number of results per page"
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endValue": {
"type": "string",
"description": "The end value of the range. This field is used for range search types."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values for the search to match against"
},
"startValue": {
"type": "string",
"description": "The start value of the range. This field is used for range search types."
},
"value": {
"type": "string",
"description": "A value for the search to match against"
},
"operator": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT"
],
"description": "How to apply this search criteria against other criteria"
},
"group": {
"type": "array",
"items": {
"type": "object"
},
"description": "Groups multiple conditions"
},
"dateFormat": {
"type": "string",
"description": "Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."
},
"type": {
"type": "string",
"enum": [
"EXACT",
"STARTS_WITH",
"CONTAINS",
"TERM",
"TERMS",
"MATCH_ALL",
"SIMPLE",
"QUERY_STRING",
"MULTI_MATCH"
],
"description": "Search Type"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Field names to search against"
}
},
"required": [
"type"
]
},
"description": "Search query string"
},
"sort": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sortOrder": {
"type": "string",
"enum": [
"ASC",
"DESC",
"SCORE"
],
"description": "The sort order for results"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
}
}
},
"description": "Multi-value sort order, list of multiple sort values"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
},
"sortOrder": {
"type": "string",
"description": "The sort order for results",
"enum": [
"ASC",
"DESC",
"SCORE"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_post\_group\_members
Add members
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------- |
| `groupId` | string | Yes | — | Group ID |
| `memberIds` | string\[] | Yes | — | A list of the ids of the members to add. A maximum of 50 members are allowed per request. |
| `version` | integer | No | — | The current group version. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "Group ID"
},
"memberIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of the ids of the members to add. A maximum of 50 members are allowed per request."
},
"version": {
"type": "integer",
"description": "The current group version."
}
},
"required": [
"PCID",
"groupId",
"memberIds"
]
}
```
***
## genesys\_users\_post\_groups
Create a group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- |
| `addresses` | object\[] | No | — | The addresses value |
| `callsEnabled` | boolean | No | — | Allow calls to be placed to this group. |
| `dateModified` | string | No | — | Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `description` | string | No | — | The description value |
| `id` | string | No | — | The globally unique identifier for the object. |
| `images` | object\[] | No | — | The images value |
| `includeOwners` | boolean | No | — | Allow owners to be included as members of the group |
| `memberCount` | integer | No | — | Number of members. |
| `name` | string | Yes | — | The group name. |
| `ownerIds` | string\[] | No | — | Owners of the group |
| `rolesEnabled` | boolean | No | — | Allow roles to be assigned to this group |
| `rulesVisible` | boolean | Yes | — | Are membership rules visible to the person requesting to view the group |
| `selfUri` | string | No | — | The URI for this object |
| `state` | string | No | — | Active, inactive, or deleted state. |
| `type` | string | Yes | — | Type of group. |
| `version` | integer | No | — | Current version for this resource. |
| `visibility` | string | Yes | — | Who can view this group |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Phone number for this contact type"
},
"extension": {
"type": "string",
"description": "Extension is set if the number is e164 valid"
},
"display": {
"type": "string",
"description": "Formatted version of the address property"
},
"type": {
"type": "string",
"enum": [
"GROUPRING",
"GROUPPHONE"
],
"description": "Contact type of the address"
},
"mediaType": {
"type": "string",
"enum": [
"PHONE"
],
"description": "Media type of the address"
}
},
"required": [
"address",
"mediaType",
"type"
]
},
"description": "The addresses value"
},
"callsEnabled": {
"type": "boolean",
"description": "Allow calls to be placed to this group."
},
"dateModified": {
"type": "string",
"description": "Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"description": {
"type": "string",
"description": "The description value"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resolution": {
"type": "string",
"description": "Height and/or width of image. ex: 640x480 or x128"
},
"imageUri": {
"type": "string",
"description": "Image Uri"
}
}
},
"description": "The images value"
},
"includeOwners": {
"type": "boolean",
"description": "Allow owners to be included as members of the group"
},
"memberCount": {
"type": "integer",
"description": "Number of members."
},
"name": {
"type": "string",
"description": "The group name."
},
"ownerIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Owners of the group"
},
"rolesEnabled": {
"type": "boolean",
"description": "Allow roles to be assigned to this group"
},
"rulesVisible": {
"type": "boolean",
"description": "Are membership rules visible to the person requesting to view the group"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"state": {
"type": "string",
"description": "Active, inactive, or deleted state.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"type": {
"type": "string",
"description": "Type of group.",
"enum": [
"official",
"social"
]
},
"version": {
"type": "integer",
"description": "Current version for this resource."
},
"visibility": {
"type": "string",
"description": "Who can view this group",
"enum": [
"public",
"owners",
"members"
]
}
},
"required": [
"PCID",
"name",
"rulesVisible",
"type",
"visibility"
]
}
```
***
## genesys\_users\_post\_groups\_search
Search groups
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | -------------------------------------------------------------- |
| `pageNumber` | integer | No | — | The page of resources you want to retrieve |
| `pageSize` | integer | No | — | The number of results per page |
| `query` | object\[] | No | — | Search query string |
| `sort` | object\[] | No | — | Multi-value sort order, list of multiple sort values |
| `sortBy` | string | No | — | The field in the resource that you want to sort the results by |
| `sortOrder` | string | No | — | The sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "The page of resources you want to retrieve"
},
"pageSize": {
"type": "integer",
"description": "The number of results per page"
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endValue": {
"type": "string",
"description": "The end value of the range. This field is used for range search types."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values for the search to match against"
},
"startValue": {
"type": "string",
"description": "The start value of the range. This field is used for range search types."
},
"value": {
"type": "string",
"description": "A value for the search to match against"
},
"operator": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT"
],
"description": "How to apply this search criteria against other criteria"
},
"group": {
"type": "array",
"items": {
"type": "object"
},
"description": "Groups multiple conditions"
},
"dateFormat": {
"type": "string",
"description": "Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."
},
"type": {
"type": "string",
"enum": [
"EXACT",
"STARTS_WITH",
"CONTAINS",
"REGEX",
"TERM",
"TERMS",
"REQUIRED_FIELDS",
"MATCH_ALL"
],
"description": "Search Type"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Field names to search against"
}
},
"required": [
"type"
]
},
"description": "Search query string"
},
"sort": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sortOrder": {
"type": "string",
"enum": [
"ASC",
"DESC",
"SCORE"
],
"description": "The sort order for results"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
}
}
},
"description": "Multi-value sort order, list of multiple sort values"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
},
"sortOrder": {
"type": "string",
"description": "The sort order for results",
"enum": [
"ASC",
"DESC",
"SCORE"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_post\_locations\_search
Search locations
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | -------------------------------------------------------------- |
| `expand` | string\[] | No | — | Provides more details about a specified resource |
| `pageNumber` | integer | No | — | The page of resources you want to retrieve |
| `pageSize` | integer | No | — | The number of results per page |
| `query` | object\[] | No | — | Search query string |
| `sort` | object\[] | No | — | Multi-value sort order, list of multiple sort values |
| `sortBy` | string | No | — | The field in the resource that you want to sort the results by |
| `sortOrder` | string | No | — | The sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provides more details about a specified resource"
},
"pageNumber": {
"type": "integer",
"description": "The page of resources you want to retrieve"
},
"pageSize": {
"type": "integer",
"description": "The number of results per page"
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endValue": {
"type": "string",
"description": "The end value of the range. This field is used for range search types."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values for the search to match against"
},
"startValue": {
"type": "string",
"description": "The start value of the range. This field is used for range search types."
},
"value": {
"type": "string",
"description": "A value for the search to match against"
},
"operator": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT"
],
"description": "How to apply this search criteria against other criteria"
},
"group": {
"type": "array",
"items": {
"type": "object"
},
"description": "Groups multiple conditions"
},
"dateFormat": {
"type": "string",
"description": "Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."
},
"type": {
"type": "string",
"enum": [
"EXACT",
"STARTS_WITH",
"CONTAINS",
"REGEX",
"TERM",
"TERMS",
"REQUIRED_FIELDS",
"MATCH_ALL"
],
"description": "Search Type"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Field names to search against"
}
},
"required": [
"type"
]
},
"description": "Search query string"
},
"sort": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sortOrder": {
"type": "string",
"enum": [
"ASC",
"DESC",
"SCORE"
],
"description": "The sort order for results"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
}
}
},
"description": "Multi-value sort order, list of multiple sort values"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
},
"sortOrder": {
"type": "string",
"description": "The sort order for results",
"enum": [
"ASC",
"DESC",
"SCORE"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_post\_presence\_definitions
Create a Presence Definition
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------ |
| `deactivated` | boolean | No | — | The deactivated value |
| `divisionId` | string | No | — | Division Id |
| `id` | string | No | — | The globally unique identifier for the object. |
| `languageLabels` | object | Yes | — | The label used for the definition in each specified language |
| `name` | string | No | — | The name value |
| `selfUri` | string | No | — | The URI for this object |
| `systemPresence` | string | No | — | System Presence |
| `type` | string | No | — | The type of definition |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deactivated": {
"type": "boolean",
"description": "The deactivated value"
},
"divisionId": {
"type": "string",
"description": "Division Id"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"languageLabels": {
"type": "object",
"description": "The label used for the definition in each specified language"
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"systemPresence": {
"type": "string",
"description": "System Presence",
"enum": [
"Available",
"Away",
"Busy",
"Offline",
"Idle",
"OnQueue",
"Meal",
"Training",
"Meeting",
"Break"
]
},
"type": {
"type": "string",
"description": "The type of definition",
"enum": [
"System",
"User"
]
}
},
"required": [
"PCID",
"languageLabels"
]
}
```
***
## genesys\_users\_post\_presence\_sources
Create a Presence Source
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ---------------------------------------------- |
| `deactivated` | boolean | No | — | The deactivated value |
| `description` | string | No | — | The description of the source |
| `id` | string | No | — | The globally unique identifier for the object. |
| `name` | string | Yes | — | The name of the source |
| `selfUri` | string | No | — | The URI for this object |
| `type` | string | No | — | The type of source |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deactivated": {
"type": "boolean",
"description": "The deactivated value"
},
"description": {
"type": "string",
"description": "The description of the source"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name of the source"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"type": {
"type": "string",
"description": "The type of source",
"enum": [
"System",
"User"
]
}
},
"required": [
"PCID",
"name"
]
}
```
***
## genesys\_users\_post\_search
Search users
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `enforcePermissions` | boolean | No | — | This property only applies to api/v2/user/search; when set to true add additional search criteria to filter users by: directory:user:view |
| `expand` | any\[] | No | — | Provides more details about a specified resource |
| `integrationPresenceSource` | string | No | — | Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an "expand". When using this parameter the maximum number of users that can be returned is 100. |
| `pageNumber` | integer | No | — | The page of resources you want to retrieve |
| `pageSize` | integer | No | — | The number of results per page |
| `query` | any\[] | No | — | query |
| `sort` | any\[] | No | — | Multi-value sort order, list of multiple sort values |
| `sortBy` | string | No | — | The field in the resource that you want to sort the results by |
| `sortOrder` | string | No | — | The sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"enforcePermissions": {
"type": "boolean",
"description": "This property only applies to api/v2/user/search; when set to true add additional search criteria to filter users by: directory:user:view"
},
"expand": {
"type": "array",
"description": "Provides more details about a specified resource"
},
"integrationPresenceSource": {
"type": "string",
"description": "Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100.",
"enum": [
"MicrosoftTeams",
"ZoomPhone",
"EightByEight"
]
},
"pageNumber": {
"type": "integer",
"description": "The page of resources you want to retrieve"
},
"pageSize": {
"type": "integer",
"description": "The number of results per page"
},
"query": {
"type": "array",
"description": "query"
},
"sort": {
"type": "array",
"description": "Multi-value sort order, list of multiple sort values"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
},
"sortOrder": {
"type": "string",
"description": "The sort order for results",
"enum": [
"ASC",
"DESC",
"SCORE"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_post\_search
Search users
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `enforcePermissions` | boolean | No | — | This property only applies to api/v2/user/search; when set to true add additional search criteria to filter users by: directory:user:view |
| `expand` | string\[] | No | — | Provides more details about a specified resource |
| `integrationPresenceSource` | string | No | — | Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an "expand". When using this parameter the maximum number of users that can be returned is 100. |
| `pageNumber` | integer | No | — | The page of resources you want to retrieve |
| `pageSize` | integer | No | — | The number of results per page |
| `query` | object\[] | No | — | Search query string |
| `sort` | object\[] | No | — | Multi-value sort order, list of multiple sort values |
| `sortBy` | string | No | — | The field in the resource that you want to sort the results by |
| `sortOrder` | string | No | — | The sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"enforcePermissions": {
"type": "boolean",
"description": "This property only applies to api/v2/user/search; when set to true add additional search criteria to filter users by: directory:user:view"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provides more details about a specified resource"
},
"integrationPresenceSource": {
"type": "string",
"description": "Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100.",
"enum": [
"MicrosoftTeams",
"ZoomPhone",
"EightByEight"
]
},
"pageNumber": {
"type": "integer",
"description": "The page of resources you want to retrieve"
},
"pageSize": {
"type": "integer",
"description": "The number of results per page"
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endValue": {
"type": "string",
"description": "The end value of the range. This field is used for range search types."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values for the search to match against"
},
"startValue": {
"type": "string",
"description": "The start value of the range. This field is used for range search types."
},
"value": {
"type": "string",
"description": "A value for the search to match against"
},
"operator": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT"
],
"description": "How to apply this search criteria against other criteria"
},
"group": {
"type": "array",
"items": {
"type": "object"
},
"description": "Groups multiple conditions"
},
"dateFormat": {
"type": "string",
"description": "Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Field names to search against"
},
"type": {
"type": "string",
"enum": [
"EXACT",
"STARTS_WITH",
"CONTAINS",
"REGEX",
"TERM",
"TERMS",
"REQUIRED_FIELDS",
"MATCH_ALL",
"QUERY_STRING",
"RANGE",
"LESS_THAN",
"LESS_THAN_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_EQUAL_TO"
],
"description": "Search Type"
}
},
"required": [
"type"
]
},
"description": "Search query string"
},
"sort": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sortOrder": {
"type": "string",
"enum": [
"ASC",
"DESC",
"SCORE"
],
"description": "The sort order for results"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
}
}
},
"description": "Multi-value sort order, list of multiple sort values"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
},
"sortOrder": {
"type": "string",
"description": "The sort order for results",
"enum": [
"ASC",
"DESC",
"SCORE"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_post\_search\_suggest
Suggest resources.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ------------------------------------------------ |
| `profile` | boolean | No | — | The profile value |
| `expand` | string\[] | No | — | Provides more details about a specified resource |
| `query` | object\[] | Yes | — | Suggest query |
| `types` | string\[] | Yes | — | Resource domain type to search |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profile": {
"type": "boolean",
"description": "The profile value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provides more details about a specified resource"
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endValue": {
"type": "string",
"description": "The end value of the range. This field is used for range search types."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values for the search to match against"
},
"startValue": {
"type": "string",
"description": "The start value of the range. This field is used for range search types."
},
"value": {
"type": "string",
"description": "A value for the search to match against"
},
"operator": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT"
],
"description": "How to apply this search criteria against other criteria"
},
"group": {
"type": "array",
"items": {
"type": "object"
},
"description": "Groups multiple conditions"
},
"dateFormat": {
"type": "string",
"description": "Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Field names to search against"
}
}
},
"description": "Suggest query"
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"description": "Resource domain type to search"
}
},
"required": [
"PCID",
"query",
"types"
]
}
```
***
## genesys\_users\_post\_search\_teams\_assign
Search users assigned to teams
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `enforcePermissions` | boolean | No | — | This property only applies to api/v2/user/search; when set to true add additional search criteria to filter users by: directory:user:view |
| `expand` | string\[] | No | — | Provides more details about a specified resource |
| `integrationPresenceSource` | string | No | — | Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an "expand". When using this parameter the maximum number of users that can be returned is 100. |
| `pageNumber` | integer | No | — | The page of resources you want to retrieve |
| `pageSize` | integer | No | — | The number of results per page |
| `query` | object\[] | No | — | Search query string |
| `sort` | object\[] | No | — | Multi-value sort order, list of multiple sort values |
| `sortBy` | string | No | — | The field in the resource that you want to sort the results by |
| `sortOrder` | string | No | — | The sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"enforcePermissions": {
"type": "boolean",
"description": "This property only applies to api/v2/user/search; when set to true add additional search criteria to filter users by: directory:user:view"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provides more details about a specified resource"
},
"integrationPresenceSource": {
"type": "string",
"description": "Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100.",
"enum": [
"MicrosoftTeams",
"ZoomPhone",
"EightByEight"
]
},
"pageNumber": {
"type": "integer",
"description": "The page of resources you want to retrieve"
},
"pageSize": {
"type": "integer",
"description": "The number of results per page"
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endValue": {
"type": "string",
"description": "The end value of the range. This field is used for range search types."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values for the search to match against"
},
"startValue": {
"type": "string",
"description": "The start value of the range. This field is used for range search types."
},
"value": {
"type": "string",
"description": "A value for the search to match against"
},
"operator": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT"
],
"description": "How to apply this search criteria against other criteria"
},
"group": {
"type": "array",
"items": {
"type": "object"
},
"description": "Groups multiple conditions"
},
"dateFormat": {
"type": "string",
"description": "Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Field names to search against"
},
"type": {
"type": "string",
"enum": [
"EXACT",
"STARTS_WITH",
"CONTAINS",
"REGEX",
"TERM",
"TERMS",
"REQUIRED_FIELDS",
"MATCH_ALL",
"QUERY_STRING",
"RANGE",
"LESS_THAN",
"LESS_THAN_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_EQUAL_TO"
],
"description": "Search Type"
}
},
"required": [
"type"
]
},
"description": "Search query string"
},
"sort": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sortOrder": {
"type": "string",
"enum": [
"ASC",
"DESC",
"SCORE"
],
"description": "The sort order for results"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
}
}
},
"description": "Multi-value sort order, list of multiple sort values"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
},
"sortOrder": {
"type": "string",
"description": "The sort order for results",
"enum": [
"ASC",
"DESC",
"SCORE"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_post\_speechandtextanalytics\_transcripts\_search
Search resources.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------------------------------- |
| `pageNumber` | integer | No | — | The page of resources you want to retrieve |
| `pageSize` | integer | No | — | The number of results per page |
| `query` | object\[] | No | — | The search criteria |
| `returnFields` | string\[] | No | — | Return Fields |
| `sort` | object\[] | No | — | Multi-value sort order, list of multiple sort values |
| `sortBy` | string | No | — | The field in the resource that you want to sort the results by |
| `sortOrder` | string | No | — | The sort order for results |
| `types` | string\[] | Yes | — | Resource domain type to search |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "The page of resources you want to retrieve"
},
"pageSize": {
"type": "integer",
"description": "The number of results per page"
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endValue": {
"type": "string",
"description": "The end value of the range. This field is used for range search types."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values for the search to match against"
},
"startValue": {
"type": "string",
"description": "The start value of the range. This field is used for range search types."
},
"value": {
"type": "string",
"description": "A value for the search to match against"
},
"operator": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT"
],
"description": "How to apply this search criteria against other criteria"
},
"group": {
"type": "array",
"items": {
"type": "object"
},
"description": "Groups multiple conditions"
},
"dateFormat": {
"type": "string",
"description": "Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."
},
"type": {
"type": "string",
"enum": [
"EXACT",
"EXACT_PHRASE",
"PHRASE",
"DATE_RANGE",
"RANGE",
"GREATER_THAN",
"LESS_THAN"
],
"description": "The type value"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Field names to search against"
}
}
},
"description": "The search criteria"
},
"returnFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return Fields"
},
"sort": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sortOrder": {
"type": "string",
"enum": [
"ASC",
"DESC",
"SCORE"
],
"description": "The sort order for results"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
}
}
},
"description": "Multi-value sort order, list of multiple sort values"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
},
"sortOrder": {
"type": "string",
"description": "The sort order for results",
"enum": [
"ASC",
"DESC",
"SCORE"
]
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"description": "Resource domain type to search"
}
},
"required": [
"PCID",
"types"
]
}
```
***
## genesys\_users\_post\_team\_members
Add team members
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | --------- | -------- | ------- | ------------------------------------------------- |
| `teamId` | string | Yes | — | Team ID |
| `memberIds` | string\[] | Yes | — | A list of the ids of the members to add or remove |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "string",
"description": "Team ID"
},
"memberIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of the ids of the members to add or remove"
}
},
"required": [
"PCID",
"teamId",
"memberIds"
]
}
```
***
## genesys\_users\_post\_teams
Create a team
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- |
| `dateCreated` | string | No | — | Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `dateModified` | string | No | — | Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `description` | string | No | — | Team information. |
| `division` | object | No | — | The division value |
| `id` | string | No | — | The globally unique identifier for the object. |
| `memberCount` | integer | No | — | Number of members in a team |
| `name` | string | Yes | — | The team name |
| `selfUri` | string | No | — | The URI for this object |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"dateCreated": {
"type": "string",
"description": "Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"description": {
"type": "string",
"description": "Team information."
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"memberCount": {
"type": "integer",
"description": "Number of members in a team"
},
"name": {
"type": "string",
"description": "The team name"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"name"
]
}
```
***
## genesys\_users\_post\_teams\_search
Search resources.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | -------------------------------------------------------------- |
| `pageNumber` | integer | No | — | The page of resources you want to retrieve |
| `pageSize` | integer | No | — | The number of results per page |
| `query` | object\[] | Yes | — | Team Search Criteria |
| `sort` | object\[] | No | — | Multi-value sort order, list of multiple sort values |
| `sortBy` | string | No | — | The field in the resource that you want to sort the results by |
| `sortOrder` | string | No | — | The sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "The page of resources you want to retrieve"
},
"pageSize": {
"type": "integer",
"description": "The number of results per page"
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endValue": {
"type": "string",
"description": "The end value of the range. This field is used for range search types."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values for the search to match against"
},
"startValue": {
"type": "string",
"description": "The start value of the range. This field is used for range search types."
},
"value": {
"type": "string",
"description": "A value for the search to match against"
},
"operator": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT"
],
"description": "How to apply this search criteria against other criteria"
},
"group": {
"type": "array",
"items": {
"type": "object"
},
"description": "Groups multiple conditions"
},
"dateFormat": {
"type": "string",
"description": "Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Field names to search against"
},
"type": {
"type": "string",
"enum": [
"EXACT",
"STARTS_WITH"
],
"description": "Search Type"
}
},
"required": [
"type"
]
},
"description": "Team Search Criteria"
},
"sort": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sortOrder": {
"type": "string",
"enum": [
"ASC",
"DESC",
"SCORE"
],
"description": "The sort order for results"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
}
}
},
"description": "Multi-value sort order, list of multiple sort values"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
},
"sortOrder": {
"type": "string",
"description": "The sort order for results",
"enum": [
"ASC",
"DESC",
"SCORE"
]
}
},
"required": [
"PCID",
"query"
]
}
```
***
## genesys\_users\_post\_telephony\_providers\_edges\_sites\_search
Search sites
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | -------------------------------------------------------------- |
| `expand` | string\[] | No | — | Provides more details about a specified resource |
| `pageNumber` | integer | No | — | The page of resources you want to retrieve |
| `pageSize` | integer | No | — | The number of results per page |
| `query` | object\[] | No | — | Search query string |
| `sort` | object\[] | No | — | Multi-value sort order, list of multiple sort values |
| `sortBy` | string | No | — | The field in the resource that you want to sort the results by |
| `sortOrder` | string | No | — | The sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provides more details about a specified resource"
},
"pageNumber": {
"type": "integer",
"description": "The page of resources you want to retrieve"
},
"pageSize": {
"type": "integer",
"description": "The number of results per page"
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endValue": {
"type": "string",
"description": "The end value of the range. This field is used for range search types."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values for the search to match against"
},
"startValue": {
"type": "string",
"description": "The start value of the range. This field is used for range search types."
},
"value": {
"type": "string",
"description": "A value for the search to match against"
},
"operator": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT"
],
"description": "How to apply this search criteria against other criteria"
},
"group": {
"type": "array",
"items": {
"type": "object"
},
"description": "Groups multiple conditions"
},
"dateFormat": {
"type": "string",
"description": "Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."
},
"type": {
"type": "string",
"enum": [
"EXACT",
"CONTAINS"
],
"description": "Search Type"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Field names to search against"
}
},
"required": [
"type"
]
},
"description": "Search query string"
},
"sort": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sortOrder": {
"type": "string",
"enum": [
"ASC",
"DESC",
"SCORE"
],
"description": "The sort order for results"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
}
}
},
"description": "Multi-value sort order, list of multiple sort values"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
},
"sortOrder": {
"type": "string",
"description": "The sort order for results",
"enum": [
"ASC",
"DESC",
"SCORE"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_post\_users
Create user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------- |
| `addresses` | object\[] | No | — | Email addresses and phone numbers for this user |
| `department` | string | No | — | The department value |
| `divisionId` | string | Yes | — | The division to which this user will belong |
| `email` | string | Yes | — | User's email and username |
| `name` | string | Yes | — | User's full name |
| `password` | string | No | — | User's password |
| `state` | string | No | — | Optional initialized state of the user. If not specified, state will be Active if invites are sent, otherwise Inactive. |
| `title` | string | No | — | The title value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Email address or phone number for this contact type"
},
"display": {
"type": "string",
"description": "Formatted version of the address property"
},
"mediaType": {
"type": "string",
"enum": [
"PHONE",
"EMAIL",
"SMS"
],
"description": "Media Type"
},
"type": {
"type": "string",
"enum": [
"PRIMARY",
"WORK",
"WORK2",
"WORK3",
"WORK4",
"HOME",
"MOBILE",
"MAIN",
"OTHER"
],
"description": "The type value"
},
"extension": {
"type": "string",
"description": "Use internal extension instead of address. Mutually exclusive with the address field."
},
"countryCode": {
"type": "string",
"description": "Country Code"
},
"integration": {
"type": "string",
"description": "Integration tag value if this number is associated with an external integration."
}
}
},
"description": "Email addresses and phone numbers for this user"
},
"department": {
"type": "string",
"description": "The department value"
},
"divisionId": {
"type": "string",
"description": "The division to which this user will belong"
},
"email": {
"type": "string",
"description": "User's email and username"
},
"name": {
"type": "string",
"description": "User's full name"
},
"password": {
"type": "string",
"description": "User's password"
},
"state": {
"type": "string",
"description": "Optional initialized state of the user. If not specified, state will be Active if invites are sent, otherwise Inactive.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
}
},
"required": [
"PCID",
"divisionId",
"email",
"name"
]
}
```
***
## genesys\_users\_post\_users\_search
Search users
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `enforcePermissions` | boolean | No | — | This property only applies to api/v2/user/search; when set to true add additional search criteria to filter users by: directory:user:view |
| `expand` | any\[] | No | — | Provides more details about a specified resource |
| `integrationPresenceSource` | string | No | — | Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an "expand". When using this parameter the maximum number of users that can be returned is 100. |
| `pageNumber` | integer | No | — | The page of resources you want to retrieve |
| `pageSize` | integer | No | — | The number of results per page |
| `query` | any\[] | No | — | query |
| `sort` | any\[] | No | — | Multi-value sort order, list of multiple sort values |
| `sortBy` | string | No | — | The field in the resource that you want to sort the results by |
| `sortOrder` | string | No | — | The sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"enforcePermissions": {
"type": "boolean",
"description": "This property only applies to api/v2/user/search; when set to true add additional search criteria to filter users by: directory:user:view"
},
"expand": {
"type": "array",
"description": "Provides more details about a specified resource"
},
"integrationPresenceSource": {
"type": "string",
"description": "Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 100.",
"enum": [
"MicrosoftTeams",
"ZoomPhone",
"EightByEight"
]
},
"pageNumber": {
"type": "integer",
"description": "The page of resources you want to retrieve"
},
"pageSize": {
"type": "integer",
"description": "The number of results per page"
},
"query": {
"type": "array",
"description": "query"
},
"sort": {
"type": "array",
"description": "Multi-value sort order, list of multiple sort values"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
},
"sortOrder": {
"type": "string",
"description": "The sort order for results",
"enum": [
"ASC",
"DESC",
"SCORE"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_post\_voicemail\_search
Search voicemails
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | -------------------------------------------------------------- |
| `expand` | string\[] | No | — | Provides more details about a specified resource |
| `pageNumber` | integer | No | — | The page of resources you want to retrieve |
| `pageSize` | integer | No | — | The number of results per page |
| `query` | object\[] | No | — | Search query string |
| `sort` | object\[] | No | — | Multi-value sort order, list of multiple sort values |
| `sortBy` | string | No | — | The field in the resource that you want to sort the results by |
| `sortOrder` | string | No | — | The sort order for results |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Provides more details about a specified resource"
},
"pageNumber": {
"type": "integer",
"description": "The page of resources you want to retrieve"
},
"pageSize": {
"type": "integer",
"description": "The number of results per page"
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endValue": {
"type": "string",
"description": "The end value of the range. This field is used for range search types."
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of values for the search to match against"
},
"startValue": {
"type": "string",
"description": "The start value of the range. This field is used for range search types."
},
"value": {
"type": "string",
"description": "A value for the search to match against"
},
"operator": {
"type": "string",
"enum": [
"AND",
"OR",
"NOT"
],
"description": "How to apply this search criteria against other criteria"
},
"group": {
"type": "array",
"items": {
"type": "object"
},
"description": "Groups multiple conditions"
},
"dateFormat": {
"type": "string",
"description": "Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Field names to search against"
},
"type": {
"type": "string",
"enum": [
"EXACT",
"STARTS_WITH",
"CONTAINS",
"REGEX",
"TERM",
"TERMS",
"REQUIRED_FIELDS",
"MATCH_ALL",
"DATE_RANGE"
],
"description": "Search Type"
}
},
"required": [
"type"
]
},
"description": "Search query string"
},
"sort": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sortOrder": {
"type": "string",
"enum": [
"ASC",
"DESC",
"SCORE"
],
"description": "The sort order for results"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
}
}
},
"description": "Multi-value sort order, list of multiple sort values"
},
"sortBy": {
"type": "string",
"description": "The field in the resource that you want to sort the results by"
},
"sortOrder": {
"type": "string",
"description": "The sort order for results",
"enum": [
"ASC",
"DESC",
"SCORE"
]
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_put\_group
Update group
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | ----------------------------------------------------------------------- |
| `groupId` | string | Yes | — | Group ID |
| `addresses` | object\[] | No | — | The addresses value |
| `callsEnabled` | boolean | No | — | Allow calls to be placed to this group. |
| `description` | string | No | — | The description value |
| `id` | string | No | — | The globally unique identifier for the object. |
| `images` | object\[] | No | — | The images value |
| `includeOwners` | boolean | No | — | Allow owners to be included as members of the group |
| `name` | string | No | — | The group name. |
| `ownerIds` | string\[] | No | — | Owners of the group |
| `rolesEnabled` | boolean | No | — | Allow roles to be assigned to this group |
| `rulesVisible` | boolean | No | — | Are membership rules visible to the person requesting to view the group |
| `selfUri` | string | No | — | The URI for this object |
| `state` | string | No | — | State of the group. |
| `version` | integer | Yes | — | Current version for this resource. |
| `visibility` | string | No | — | Who can view this group |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "Group ID"
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Phone number for this contact type"
},
"extension": {
"type": "string",
"description": "Extension is set if the number is e164 valid"
},
"display": {
"type": "string",
"description": "Formatted version of the address property"
},
"type": {
"type": "string",
"enum": [
"GROUPRING",
"GROUPPHONE"
],
"description": "Contact type of the address"
},
"mediaType": {
"type": "string",
"enum": [
"PHONE"
],
"description": "Media type of the address"
}
},
"required": [
"address",
"mediaType",
"type"
]
},
"description": "The addresses value"
},
"callsEnabled": {
"type": "boolean",
"description": "Allow calls to be placed to this group."
},
"description": {
"type": "string",
"description": "The description value"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resolution": {
"type": "string",
"description": "Height and/or width of image. ex: 640x480 or x128"
},
"imageUri": {
"type": "string",
"description": "Image Uri"
}
}
},
"description": "The images value"
},
"includeOwners": {
"type": "boolean",
"description": "Allow owners to be included as members of the group"
},
"name": {
"type": "string",
"description": "The group name."
},
"ownerIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Owners of the group"
},
"rolesEnabled": {
"type": "boolean",
"description": "Allow roles to be assigned to this group"
},
"rulesVisible": {
"type": "boolean",
"description": "Are membership rules visible to the person requesting to view the group"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"state": {
"type": "string",
"description": "State of the group.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"version": {
"type": "integer",
"description": "Current version for this resource."
},
"visibility": {
"type": "string",
"description": "Who can view this group",
"enum": [
"public",
"ownerIds",
"members"
]
}
},
"required": [
"PCID",
"groupId",
"version"
]
}
```
***
## genesys\_users\_put\_presence\_definition
Update a Presence Definition
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------ |
| `definitionId` | string | Yes | — | Presence Definition ID |
| `deactivated` | boolean | No | — | The deactivated value |
| `divisionId` | string | No | — | Division Id |
| `id` | string | No | — | The globally unique identifier for the object. |
| `languageLabels` | object | Yes | — | The label used for the definition in each specified language |
| `name` | string | No | — | The name value |
| `selfUri` | string | No | — | The URI for this object |
| `systemPresence` | string | No | — | System Presence |
| `type` | string | No | — | The type of definition |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"definitionId": {
"type": "string",
"description": "Presence Definition ID"
},
"deactivated": {
"type": "boolean",
"description": "The deactivated value"
},
"divisionId": {
"type": "string",
"description": "Division Id"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"languageLabels": {
"type": "object",
"description": "The label used for the definition in each specified language"
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"systemPresence": {
"type": "string",
"description": "System Presence",
"enum": [
"Available",
"Away",
"Busy",
"Offline",
"Idle",
"OnQueue",
"Meal",
"Training",
"Meeting",
"Break"
]
},
"type": {
"type": "string",
"description": "The type of definition",
"enum": [
"System",
"User"
]
}
},
"required": [
"PCID",
"definitionId",
"languageLabels"
]
}
```
***
## genesys\_users\_put\_presence\_settings
Update the presence settings
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------------------ | ------- | -------- | ------- | ---------------------------------------------------------------------- |
| `defaultPrimaryPresenceRegisteredSourceId` | string | No | — | The default primary presence registered source ID for the organization |
| `id` | string | No | — | The globally unique identifier for the object. |
| `name` | string | No | — | The name value |
| `requestingOffQueueEnabled` | boolean | No | — | Whether requesting off queue is enabled for the organization |
| `restorePresenceSettings` | object | No | — | Restore Presence Settings |
| `selfUri` | string | No | — | The URI for this object |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"defaultPrimaryPresenceRegisteredSourceId": {
"type": "string",
"description": "The default primary presence registered source ID for the organization"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"requestingOffQueueEnabled": {
"type": "boolean",
"description": "Whether requesting off queue is enabled for the organization"
},
"restorePresenceSettings": {
"type": "object",
"description": "Restore Presence Settings",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the restore presence feature is enabled"
},
"restoreTimeMilliseconds": {
"type": "integer",
"description": "How many milliseconds the presence will be restored within"
},
"restoreOnQueueEnabled": {
"type": "boolean",
"description": "Whether the ON_QUEUE presence will be restored"
}
},
"required": [
"enabled",
"restoreOnQueueEnabled",
"restoreTimeMilliseconds"
]
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID"
]
}
```
***
## genesys\_users\_put\_presence\_source
Update a Presence Source
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ---------------------------------------------- |
| `sourceId` | string | Yes | — | Presence Source ID |
| `deactivated` | boolean | No | — | The deactivated value |
| `description` | string | No | — | The description of the source |
| `id` | string | No | — | The globally unique identifier for the object. |
| `name` | string | Yes | — | The name of the source |
| `selfUri` | string | No | — | The URI for this object |
| `type` | string | No | — | The type of source |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sourceId": {
"type": "string",
"description": "Presence Source ID"
},
"deactivated": {
"type": "boolean",
"description": "The deactivated value"
},
"description": {
"type": "string",
"description": "The description of the source"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name of the source"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"type": {
"type": "string",
"description": "The type of source",
"enum": [
"System",
"User"
]
}
},
"required": [
"PCID",
"sourceId",
"name"
]
}
```
***
## genesys\_users\_put\_presence\_user\_primarysource
Update a user's Primary Presence Source
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ---------------------------------------------- |
| `userId` | string | Yes | — | user ID |
| `id` | string | No | — | The globally unique identifier for the object. |
| `name` | string | No | — | The name value |
| `registered` | boolean | No | — | Whether or not the source is registered |
| `selfUri` | string | No | — | The URI for this object |
| `sourceId` | string | No | — | The id of the source |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "user ID"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"registered": {
"type": "boolean",
"description": "Whether or not the source is registered"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"sourceId": {
"type": "string",
"description": "The id of the source"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_put\_stations\_me\_associatedstation\_station\_id
Set self associated station
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `stationId` | string | Yes | — | Station Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"stationId": {
"type": "string",
"description": "Station Id"
}
},
"required": [
"PCID",
"stationId"
]
}
```
***
## genesys\_users\_put\_user\_callforwarding
Update a user's CallForwarding
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | User ID |
| `calls` | object\[] | No | — | An ordered list of CallRoutes to be executed when CallForwarding is enabled |
| `enabled` | boolean | No | — | Whether or not CallForwarding is enabled |
| `id` | string | No | — | The globally unique identifier for the object. |
| `modifiedDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `name` | string | No | — | The name value |
| `phoneNumber` | string | No | — | This property is deprecated. Please use the calls property |
| `selfUri` | string | No | — | The URI for this object |
| `user` | object | No | — | The user value |
| `voicemail` | string | No | — | The type of voicemail to use with the callForwarding configuration |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"calls": {
"type": "array",
"items": {
"type": "object",
"properties": {
"targets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of call"
},
"value": {
"type": "string",
"description": "The id of the station or an E.164 formatted phone number"
}
}
},
"description": "A list of CallTargets to be called when the CallRoute is executed"
}
}
},
"description": "An ordered list of CallRoutes to be executed when CallForwarding is enabled"
},
"enabled": {
"type": "boolean",
"description": "Whether or not CallForwarding is enabled"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"modifiedDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"name": {
"type": "string",
"description": "The name value"
},
"phoneNumber": {
"type": "string",
"description": "This property is deprecated. Please use the calls property"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"user": {
"type": "object",
"description": "The user value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
},
"voicemail": {
"type": "string",
"description": "The type of voicemail to use with the callForwarding configuration",
"enum": [
"PURECLOUD",
"LASTCALL",
"NONE"
]
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_put\_user\_outofoffice
Update an OutOfOffice
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | User ID |
| `active` | boolean | No | — | The active value |
| `endDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `id` | string | No | — | The globally unique identifier for the object. |
| `indefinite` | boolean | No | — | The indefinite value |
| `name` | string | No | — | The name value |
| `selfUri` | string | No | — | The URI for this object |
| `startDate` | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `user` | object | No | — | The user value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"active": {
"type": "boolean",
"description": "The active value"
},
"endDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"indefinite": {
"type": "boolean",
"description": "The indefinite value"
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"startDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"user": {
"type": "object",
"description": "The user value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/OutOfOffice"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_put\_user\_profileskills
Update profile skills for a user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User ID |
| `body` | string\[] | Yes | — | Skills |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"body": {
"type": "array",
"items": {
"type": "string"
},
"description": "Skills"
}
},
"required": [
"PCID",
"userId",
"body"
]
}
```
***
## genesys\_users\_put\_user\_roles
Sets the user's roles
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | --------- | -------- | ------- | ------------- |
| `subjectId` | string | Yes | — | User ID |
| `body` | string\[] | Yes | — | List of roles |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"subjectId": {
"type": "string",
"description": "User ID"
},
"body": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of roles"
}
},
"required": [
"PCID",
"subjectId",
"body"
]
}
```
***
## genesys\_users\_put\_user\_routingstatus
Update the routing status of a user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | User ID |
| `startTime` | string | No | — | The timestamp when the agent went into this state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `status` | string | No | — | Indicates the Routing State of the agent. A value of OFF\_QUEUE will be returned if the specified user does not exist. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"startTime": {
"type": "string",
"description": "The timestamp when the agent went into this state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"status": {
"type": "string",
"description": "Indicates the Routing State of the agent. A value of OFF_QUEUE will be returned if the specified user does not exist.",
"enum": [
"OFF_QUEUE",
"IDLE",
"INTERACTING",
"NOT_RESPONDING",
"COMMUNICATING"
]
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_put\_user\_state
Update user state information.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `userId` | string | Yes | — | User ID |
| `state` | string | No | — | User's current state. |
| `stateChangeDate` | string | No | — | Date that the state was last changed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z |
| `stateChangeReason` | string | No | — | Reason for a change in the user's state. |
| `version` | integer | No | — | Version of this user. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"state": {
"type": "string",
"description": "User's current state.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"stateChangeDate": {
"type": "string",
"description": "Date that the state was last changed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"stateChangeReason": {
"type": "string",
"description": "Reason for a change in the user's state.",
"enum": [
"Voluntary",
"Seasonal",
"Leave",
"Performance",
"Conduct",
"Unknown"
]
},
"version": {
"type": "integer",
"description": "Version of this user."
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## genesys\_users\_put\_user\_station\_associatedstation\_station\_id
Set associated station
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User ID |
| `stationId` | string | Yes | — | Station Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"stationId": {
"type": "string",
"description": "Station Id"
}
},
"required": [
"PCID",
"userId",
"stationId"
]
}
```
***
## genesys\_users\_put\_user\_station\_defaultstation\_station\_id
Set default station
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ----------- |
| `userId` | string | Yes | — | User ID |
| `stationId` | string | Yes | — | Station Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"stationId": {
"type": "string",
"description": "Station Id"
}
},
"required": [
"PCID",
"userId",
"stationId"
]
}
```