genesys-users - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /genesys-users | Type: Application | PCID required: Yes

Tools

Tool	Description
`genesys_users_delete_group`	Delete group
`genesys_users_delete_group_members`	Remove members
`genesys_users_delete_presence_definition`	Delete a Presence Definition
`genesys_users_delete_presence_source`	Delete a Presence Source
`genesys_users_delete_team`	Delete team
`genesys_users_delete_team_members`	Delete team members
`genesys_users_delete_user`	Delete user
`genesys_users_delete_user_station_associatedstation`	Clear associated station
`genesys_users_delete_user_station_defaultstation`	Clear default station
`genesys_users_get_authorization_divisionspermitted_paged_me`	Returns which divisions the current user has the given permission in.
`genesys_users_get_documentation_gkn_search`	Search gkn documentation using the q64 value returned from a previous search
`genesys_users_get_documentation_search`	Search documentation using the q64 value returned from a previous search
`genesys_users_get_group`	Get group
`genesys_users_get_group_individuals`	Get all individuals associated with the group
`genesys_users_get_group_members`	Get group members, includes individuals, owners, and dynamically included people
`genesys_users_get_groups`	Get a group list
`genesys_users_get_groups_search`	Search groups using the q64 value returned from a previous search
`genesys_users_get_locations_search`	Search locations using the q64 value returned from a previous search
`genesys_users_get_me`	Get current user details.
`genesys_users_get_presence_definition`	Get a Presence Definition
`genesys_users_get_presence_definitions`	Get a list of Presence Definitions
`genesys_users_get_presence_settings`	Get the presence settings
`genesys_users_get_presence_source`	Get a Presence Source
`genesys_users_get_presence_sources`	Get a list of Presence Sources
`genesys_users_get_presence_user_primarysource`	Get a user’s Primary Presence Source
`genesys_users_get_search`	Search users using the q64 value returned from a previous search
`genesys_users_get_search`	Search using the q64 value returned from a previous search.
`genesys_users_get_search_suggest`	Suggest resources using the q64 value returned from a previous suggest query.
`genesys_users_get_systempresences`	Get the list of SystemPresences
`genesys_users_get_team`	Get team
`genesys_users_get_team_members`	Get team membership
`genesys_users_get_teams`	Get Team listing
`genesys_users_get_telephony_providers_edges_sites_search`	Search sites using the q64 value returned from a previous search
`genesys_users_get_user`	Get user.
`genesys_users_get_user_callforwarding`	Get a user’s CallForwarding
`genesys_users_get_user_directreports`	Get direct reports
`genesys_users_get_user_geolocation`	Get a user’s Geolocation
`genesys_users_get_user_outofoffice`	Get a OutOfOffice
`genesys_users_get_user_presence`	Get a user’s Presence
`genesys_users_get_user_presences_purecloud`	Get a user’s Genesys Cloud presence.
`genesys_users_get_user_profileskills`	List profile skills for a user
`genesys_users_get_user_queues`	Get queues for user
`genesys_users_get_user_roles`	Returns a listing of roles and permissions for a user.
`genesys_users_get_user_routinglanguages`	List routing languages assigned to a user
`genesys_users_get_user_routingskills`	List routing skills assigned to a user
`genesys_users_get_user_routingstatus`	Fetch the routing status of a user
`genesys_users_get_user_state`	Get user state information.
`genesys_users_get_user_station`	Get station information for user
`genesys_users_get_user_superiors`	Get superiors
`genesys_users_get_user_trustors`	List the organizations that have authorized/trusted the user.
`genesys_users_get_users`	Get the list of available users.
`genesys_users_get_users_me`	Get current user details.
`genesys_users_get_users_presences_purecloud_bulk`	Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
`genesys_users_get_voicemail_search`	Search voicemails using the q64 value returned from a previous search
`genesys_users_patch_team`	Update team
`genesys_users_patch_user`	Update user
`genesys_users_patch_user_callforwarding`	Patch a user’s CallForwarding
`genesys_users_patch_user_geolocation`	Patch a user’s Geolocation
`genesys_users_patch_user_presence`	Patch a user’s Presence
`genesys_users_patch_user_presences_purecloud`	Patch a Genesys Cloud user’s presence
`genesys_users_post_documentation_gkn_search`	Search gkn documentation
`genesys_users_post_documentation_search`	Search documentation
`genesys_users_post_group_members`	Add members
`genesys_users_post_groups`	Create a group
`genesys_users_post_groups_search`	Search groups
`genesys_users_post_locations_search`	Search locations
`genesys_users_post_presence_definitions`	Create a Presence Definition
`genesys_users_post_presence_sources`	Create a Presence Source
`genesys_users_post_search`	Search users
`genesys_users_post_search`	Search resources.
`genesys_users_post_search_suggest`	Suggest resources.
`genesys_users_post_search_teams_assign`	Search users assigned to teams
`genesys_users_post_speechandtextanalytics_transcripts_search`	Search resources.
`genesys_users_post_team_members`	Add team members
`genesys_users_post_teams`	Create a team
`genesys_users_post_teams_search`	Search resources.
`genesys_users_post_telephony_providers_edges_sites_search`	Search sites
`genesys_users_post_users`	Create user
`genesys_users_post_users_search`	Search users
`genesys_users_post_voicemail_search`	Search voicemails
`genesys_users_put_group`	Update group
`genesys_users_put_presence_definition`	Update a Presence Definition
`genesys_users_put_presence_settings`	Update the presence settings
`genesys_users_put_presence_source`	Update a Presence Source
`genesys_users_put_presence_user_primarysource`	Update a user’s Primary Presence Source
`genesys_users_put_user_callforwarding`	Update a user’s CallForwarding
`genesys_users_put_user_outofoffice`	Update an OutOfOffice
`genesys_users_put_user_profileskills`	Update profile skills for a user
`genesys_users_put_user_roles`	Sets the user’s roles
`genesys_users_put_user_routingstatus`	Update the routing status of a user
`genesys_users_put_user_state`	Update user state information.
`genesys_users_put_user_station_associatedstation_station_id`	Set associated station
`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

Show inputSchema

{
  "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.

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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_team

Delete team Parameters:

Parameter	Type	Required	Default	Description
`teamId`	string	Yes	—	Team ID

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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	—	q64

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "q64": {
      "type": "string",
      "description": "q64"
    }
  },
  "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	—	q64

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "q64": {
      "type": "string",
      "description": "q64"
    }
  },
  "required": [
    "PCID",
    "q64"
  ]
}

genesys_users_get_group

Get group Parameters:

Parameter	Type	Required	Default	Description
`groupId`	string	Yes	—	Group ID

Show inputSchema

{
  "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

Show inputSchema

{
  "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`	any[]	No	—	Which fields, if any, to expand

Show inputSchema

{
  "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",
      "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`	any[]	No	—	id
`jabberId`	any[]	No	—	A list of jabberIds to fetch by bulk (cannot be used with the “id” parameter)
`sortOrder`	string	No	—	Ascending or descending sort order

Show inputSchema

{
  "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",
      "description": "id"
    },
    "jabberId": {
      "type": "array",
      "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	—	q64
`expand`	any[]	No	—	expand

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "q64": {
      "type": "string",
      "description": "q64"
    },
    "expand": {
      "type": "array",
      "description": "expand"
    }
  },
  "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	—	q64
`expand`	any[]	No	—	Provides more details about a specified resource

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "q64": {
      "type": "string",
      "description": "q64"
    },
    "expand": {
      "type": "array",
      "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`	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”.

Show inputSchema

{
  "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_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.

Show inputSchema

{
  "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`	any[]	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.

Show inputSchema

{
  "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",
      "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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_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

Show inputSchema

{
  "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 using the q64 value returned from a previous search. Parameters:

Parameter	Type	Required	Default	Description
`q64`	string	Yes	—	q64
`expand`	any[]	No	—	Which fields, if any, to expand
`profile`	boolean	No	—	profile

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "q64": {
      "type": "string",
      "description": "q64"
    },
    "expand": {
      "type": "array",
      "description": "Which fields, if any, to expand"
    },
    "profile": {
      "type": "boolean",
      "description": "profile"
    }
  },
  "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	—	q64
`expand`	any[]	No	—	Which fields, if any, to expand
`profile`	boolean	No	—	profile

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "q64": {
      "type": "string",
      "description": "q64"
    },
    "expand": {
      "type": "array",
      "description": "Which fields, if any, to expand"
    },
    "profile": {
      "type": "boolean",
      "description": "profile"
    }
  },
  "required": [
    "PCID",
    "q64"
  ]
}

genesys_users_get_systempresences

Get the list of SystemPresences

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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	—	q64
`expand`	any[]	No	—	expand

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "q64": {
      "type": "string",
      "description": "q64"
    },
    "expand": {
      "type": "array",
      "description": "expand"
    }
  },
  "required": [
    "PCID",
    "q64"
  ]
}

genesys_users_get_user

Get user. Parameters:

Parameter	Type	Required	Default	Description
`userId`	string	Yes	—	User ID
`expand`	any[]	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.
`state`	string	No	—	Search for a user with this state

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User ID"
    },
    "expand": {
      "type": "array",
      "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"
      ]
    },
    "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

Show inputSchema

{
  "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`	any[]	No	—	Which fields, if any, to expand

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User ID"
    },
    "expand": {
      "type": "array",
      "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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)

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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`	any[]	No	—	Which fields, if any, to expand

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User ID"
    },
    "expand": {
      "type": "array",
      "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

Show inputSchema

{
  "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`	any[]	No	—	A list of user IDs to fetch by bulk
`jabberId`	any[]	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`	any[]	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.
`state`	string	No	—	Only list users of this state

Show inputSchema

{
  "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",
      "description": "A list of user IDs to fetch by bulk"
    },
    "jabberId": {
      "type": "array",
      "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",
      "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"
      ]
    },
    "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”.

Show inputSchema

{
  "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.

Show inputSchema

{
  "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	—	q64
`expand`	any[]	No	—	expand

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "q64": {
      "type": "string",
      "description": "q64"
    },
    "expand": {
      "type": "array",
      "description": "expand"
    }
  },
  "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	—	division
`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

Show inputSchema

{
  "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": "division"
    },
    "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`	any[]	No	—	Email address, phone number, and/or extension for this user. One entry is allowed per media type
`biography`	object	No	—	biography
`certifications`	any[]	No	—	certifications
`chat`	object	No	—	chat
`department`	string	No	—	department
`email`	string	No	—	email
`employerInfo`	object	No	—	employerInfo
`groups`	any[]	No	—	The groups the user is a member of
`id`	string	No	—	The globally unique identifier for the object.
`images`	any[]	No	—	images
`locations`	any[]	No	—	The user placement at each site location.
`manager`	string	No	—	manager
`name`	string	No	—	name
`preferredName`	string	No	—	Preferred full name of agent
`primaryContactInfo`	any[]	No	—	The address(s) used for primary contact. Updates to the corresponding address in the addresses list will be reflected here.
`profileSkills`	any[]	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	—	title
`username`	string	No	—	username
`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.

Show inputSchema

{
  "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",
      "description": "Email address, phone number, and/or extension for this user. One entry is allowed per media type"
    },
    "biography": {
      "type": "object",
      "description": "biography"
    },
    "certifications": {
      "type": "array",
      "description": "certifications"
    },
    "chat": {
      "type": "object",
      "description": "chat"
    },
    "department": {
      "type": "string",
      "description": "department"
    },
    "email": {
      "type": "string",
      "description": "email"
    },
    "employerInfo": {
      "type": "object",
      "description": "employerInfo"
    },
    "groups": {
      "type": "array",
      "description": "The groups the user is a member of"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "images": {
      "type": "array",
      "description": "images"
    },
    "locations": {
      "type": "array",
      "description": "The user placement at each site location."
    },
    "manager": {
      "type": "string",
      "description": "manager"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "preferredName": {
      "type": "string",
      "description": "Preferred full name of agent"
    },
    "primaryContactInfo": {
      "type": "array",
      "description": "The address(s) used for primary contact. Updates to the corresponding address in the addresses list will be reflected here."
    },
    "profileSkills": {
      "type": "array",
      "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": "title"
    },
    "username": {
      "type": "string",
      "description": "username"
    },
    "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`	any[]	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	—	name
`phoneNumber`	string	No	—	This property is deprecated. Please use the calls property
`selfUri`	string	No	—	The URI for this object
`user`	object	No	—	user
`voicemail`	string	No	—	The type of voicemail to use with the callForwarding configuration

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User ID"
    },
    "calls": {
      "type": "array",
      "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": "name"
    },
    "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": "user"
    },
    "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	—	city
`country`	string	No	—	country
`id`	string	No	—	The globally unique identifier for the object.
`latitude`	number	No	—	latitude
`locations`	any[]	No	—	locations
`longitude`	number	No	—	longitude
`name`	string	No	—	name
`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	—	region
`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.

Show inputSchema

{
  "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": "city"
    },
    "country": {
      "type": "string",
      "description": "country"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "latitude": {
      "type": "number",
      "description": "latitude"
    },
    "locations": {
      "type": "array",
      "description": "locations"
    },
    "longitude": {
      "type": "number",
      "description": "longitude"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "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": "region"
    },
    "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	—	futurePresenceDefinition
`id`	string	No	—	The globally unique identifier for the object.
`message`	string	No	—	message
`modifiedDate`	string	No	—	Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`name`	string	No	—	name
`presenceDefinition`	object	No	—	presenceDefinition
`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.

Show inputSchema

{
  "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": "futurePresenceDefinition"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "message": {
      "type": "string",
      "description": "message"
    },
    "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": "name"
    },
    "presenceDefinition": {
      "type": "object",
      "description": "presenceDefinition"
    },
    "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	—	futurePresenceDefinition
`id`	string	No	—	The globally unique identifier for the object.
`message`	string	No	—	message
`modifiedDate`	string	No	—	Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`name`	string	No	—	name
`presenceDefinition`	object	No	—	presenceDefinition
`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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "user Id"
    },
    "futurePresenceDefinition": {
      "type": "object",
      "description": "futurePresenceDefinition"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "message": {
      "type": "string",
      "description": "message"
    },
    "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": "name"
    },
    "presenceDefinition": {
      "type": "object",
      "description": "presenceDefinition"
    },
    "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`	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

Show inputSchema

{
  "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",
      "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_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`	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

Show inputSchema

{
  "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",
      "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_group_members

Add members Parameters:

Parameter	Type	Required	Default	Description
`groupId`	string	Yes	—	Group ID
`memberIds`	any[]	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "groupId": {
      "type": "string",
      "description": "Group ID"
    },
    "memberIds": {
      "type": "array",
      "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`	any[]	No	—	addresses
`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	—	description
`id`	string	No	—	The globally unique identifier for the object.
`images`	any[]	No	—	images
`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`	any[]	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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "addresses": {
      "type": "array",
      "description": "addresses"
    },
    "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": "description"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "images": {
      "type": "array",
      "description": "images"
    },
    "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",
      "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`	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

Show inputSchema

{
  "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",
      "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_locations_search

Search locations Parameters:

Parameter	Type	Required	Default	Description
`expand`	any[]	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`	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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "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",
      "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_presence_definitions

Create a Presence Definition Parameters:

Parameter	Type	Required	Default	Description
`deactivated`	boolean	No	—	deactivated
`divisionId`	string	No	—	divisionId
`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	—	name
`selfUri`	string	No	—	The URI for this object
`systemPresence`	string	No	—	systemPresence
`type`	string	No	—	The type of definition

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deactivated": {
      "type": "boolean",
      "description": "deactivated"
    },
    "divisionId": {
      "type": "string",
      "description": "divisionId"
    },
    "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": "name"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "systemPresence": {
      "type": "string",
      "description": "systemPresence",
      "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	—	deactivated
`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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deactivated": {
      "type": "boolean",
      "description": "deactivated"
    },
    "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

Show inputSchema

{
  "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 resources. Parameters:

Parameter	Type	Required	Default	Description
`profile`	boolean	No	—	profile
`aggregations`	any[]	No	—	Aggregation criteria
`expand`	any[]	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`	any[]	No	—	The search criteria
`returnFields`	any[]	No	—	A List of strings. Possible values are any field in the resource you are searching on. The other option is to use ALL_FIELDS, when this is provided all fields in the resource will be returned in the search results.
`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
`types`	any[]	Yes	—	Resource domain type to search

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "profile": {
      "type": "boolean",
      "description": "profile"
    },
    "aggregations": {
      "type": "array",
      "description": "Aggregation criteria"
    },
    "expand": {
      "type": "array",
      "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",
      "description": "The search criteria"
    },
    "returnFields": {
      "type": "array",
      "description": "A List of strings.  Possible values are any field in the resource you are searching on.  The other option is to use ALL_FIELDS, when this is provided all fields in the resource will be returned in the search results."
    },
    "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"
      ]
    },
    "types": {
      "type": "array",
      "description": "Resource domain type to search"
    }
  },
  "required": [
    "PCID",
    "types"
  ]
}

genesys_users_post_search_suggest

Suggest resources. Parameters:

Parameter	Type	Required	Default	Description
`profile`	boolean	No	—	profile
`expand`	any[]	No	—	Provides more details about a specified resource
`query`	any[]	Yes	—	Suggest query
`types`	any[]	Yes	—	Resource domain type to search

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "profile": {
      "type": "boolean",
      "description": "profile"
    },
    "expand": {
      "type": "array",
      "description": "Provides more details about a specified resource"
    },
    "query": {
      "type": "array",
      "description": "Suggest query"
    },
    "types": {
      "type": "array",
      "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`	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

Show inputSchema

{
  "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_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`	any[]	No	—	The search criteria
`returnFields`	any[]	No	—	returnFields
`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
`types`	any[]	Yes	—	Resource domain type to search

Show inputSchema

{
  "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",
      "description": "The search criteria"
    },
    "returnFields": {
      "type": "array",
      "description": "returnFields"
    },
    "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"
      ]
    },
    "types": {
      "type": "array",
      "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`	any[]	Yes	—	A list of the ids of the members to add or remove

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "teamId": {
      "type": "string",
      "description": "Team ID"
    },
    "memberIds": {
      "type": "array",
      "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	—	division
`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

Show inputSchema

{
  "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": "division"
    },
    "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`	any[]	Yes	—	Team Search Criteria
`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

Show inputSchema

{
  "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",
      "description": "Team Search Criteria"
    },
    "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",
    "query"
  ]
}

genesys_users_post_telephony_providers_edges_sites_search

Search sites Parameters:

Parameter	Type	Required	Default	Description
`expand`	any[]	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`	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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "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",
      "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_users

Create user Parameters:

Parameter	Type	Required	Default	Description
`addresses`	any[]	No	—	Email addresses and phone numbers for this user
`department`	string	No	—	department
`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	—	title

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "addresses": {
      "type": "array",
      "description": "Email addresses and phone numbers for this user"
    },
    "department": {
      "type": "string",
      "description": "department"
    },
    "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": "title"
    }
  },
  "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

Show inputSchema

{
  "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`	any[]	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`	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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "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",
      "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_put_group

Update group Parameters:

Parameter	Type	Required	Default	Description
`groupId`	string	Yes	—	Group ID
`addresses`	any[]	No	—	addresses
`callsEnabled`	boolean	No	—	Allow calls to be placed to this group.
`description`	string	No	—	description
`id`	string	No	—	The globally unique identifier for the object.
`images`	any[]	No	—	images
`includeOwners`	boolean	No	—	Allow owners to be included as members of the group
`name`	string	No	—	The group name.
`ownerIds`	any[]	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	No	—	Current version for this resource.
`visibility`	string	No	—	Who can view this group

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "groupId": {
      "type": "string",
      "description": "Group ID"
    },
    "addresses": {
      "type": "array",
      "description": "addresses"
    },
    "callsEnabled": {
      "type": "boolean",
      "description": "Allow calls to be placed to this group."
    },
    "description": {
      "type": "string",
      "description": "description"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "images": {
      "type": "array",
      "description": "images"
    },
    "includeOwners": {
      "type": "boolean",
      "description": "Allow owners to be included as members of the group"
    },
    "name": {
      "type": "string",
      "description": "The group name."
    },
    "ownerIds": {
      "type": "array",
      "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"
  ]
}

genesys_users_put_presence_definition

Update a Presence Definition Parameters:

Parameter	Type	Required	Default	Description
`definitionId`	string	Yes	—	Presence Definition ID
`deactivated`	boolean	No	—	deactivated
`divisionId`	string	No	—	divisionId
`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	—	name
`selfUri`	string	No	—	The URI for this object
`systemPresence`	string	No	—	systemPresence
`type`	string	No	—	The type of definition

Show inputSchema

{
  "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": "deactivated"
    },
    "divisionId": {
      "type": "string",
      "description": "divisionId"
    },
    "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": "name"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "systemPresence": {
      "type": "string",
      "description": "systemPresence",
      "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	—	name
`requestingOffQueueEnabled`	boolean	No	—	Whether requesting off queue is enabled for the organization
`restorePresenceSettings`	object	No	—	restorePresenceSettings
`selfUri`	string	No	—	The URI for this object

Show inputSchema

{
  "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": "name"
    },
    "requestingOffQueueEnabled": {
      "type": "boolean",
      "description": "Whether requesting off queue is enabled for the organization"
    },
    "restorePresenceSettings": {
      "type": "object",
      "description": "restorePresenceSettings"
    },
    "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	—	deactivated
`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

Show inputSchema

{
  "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": "deactivated"
    },
    "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	—	name
`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

Show inputSchema

{
  "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": "name"
    },
    "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_user_callforwarding

Update a user’s CallForwarding Parameters:

Parameter	Type	Required	Default	Description
`userId`	string	Yes	—	User ID
`calls`	any[]	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	—	name
`phoneNumber`	string	No	—	This property is deprecated. Please use the calls property
`selfUri`	string	No	—	The URI for this object
`user`	object	No	—	user
`voicemail`	string	No	—	The type of voicemail to use with the callForwarding configuration

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User ID"
    },
    "calls": {
      "type": "array",
      "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": "name"
    },
    "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": "user"
    },
    "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	—	active
`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	—	indefinite
`name`	string	No	—	name
`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	—	user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User ID"
    },
    "active": {
      "type": "boolean",
      "description": "active"
    },
    "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": "indefinite"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "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": "user"
    }
  },
  "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`	any[]	Yes	—	Skills

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User ID"
    },
    "body": {
      "type": "array",
      "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`	any[]	Yes	—	List of roles

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "subjectId": {
      "type": "string",
      "description": "User ID"
    },
    "body": {
      "type": "array",
      "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.

Show inputSchema

{
  "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.

Show inputSchema

{
  "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	—	stationId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User ID"
    },
    "stationId": {
      "type": "string",
      "description": "stationId"
    }
  },
  "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	—	stationId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "User ID"
    },
    "stationId": {
      "type": "string",
      "description": "stationId"
    }
  },
  "required": [
    "PCID",
    "userId",
    "stationId"
  ]
}

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

​Tools

​genesys_users_delete_group

​genesys_users_delete_group_members

​genesys_users_delete_presence_definition

​genesys_users_delete_presence_source

​genesys_users_delete_team

​genesys_users_delete_team_members

​genesys_users_delete_user

​genesys_users_delete_user_station_associatedstation

​genesys_users_delete_user_station_defaultstation

​genesys_users_get_authorization_divisionspermitted_paged_me

​genesys_users_get_documentation_gkn_search

​genesys_users_get_documentation_search

​genesys_users_get_group

​genesys_users_get_group_individuals

​genesys_users_get_group_members

​genesys_users_get_groups

​genesys_users_get_groups_search

​genesys_users_get_locations_search

​genesys_users_get_me

​genesys_users_get_presence_definition

​genesys_users_get_presence_definitions

​genesys_users_get_presence_settings

​genesys_users_get_presence_source

​genesys_users_get_presence_sources

​genesys_users_get_presence_user_primarysource

​genesys_users_get_search

​genesys_users_get_search

​genesys_users_get_search_suggest

​genesys_users_get_systempresences

​genesys_users_get_team

​genesys_users_get_team_members

​genesys_users_get_teams

​genesys_users_get_telephony_providers_edges_sites_search

​genesys_users_get_user

​genesys_users_get_user_callforwarding

​genesys_users_get_user_directreports

​genesys_users_get_user_geolocation

​genesys_users_get_user_outofoffice

​genesys_users_get_user_presence

​genesys_users_get_user_presences_purecloud

​genesys_users_get_user_profileskills

​genesys_users_get_user_queues

​genesys_users_get_user_roles

​genesys_users_get_user_routinglanguages

​genesys_users_get_user_routingskills

​genesys_users_get_user_routingstatus

​genesys_users_get_user_state

​genesys_users_get_user_station

​genesys_users_get_user_superiors

​genesys_users_get_user_trustors

​genesys_users_get_users

​genesys_users_get_users_me

​genesys_users_get_users_presences_purecloud_bulk

​genesys_users_get_voicemail_search

​genesys_users_patch_team

​genesys_users_patch_user

​genesys_users_patch_user_callforwarding

​genesys_users_patch_user_geolocation

​genesys_users_patch_user_presence

​genesys_users_patch_user_presences_purecloud

​genesys_users_post_documentation_gkn_search

​genesys_users_post_documentation_search

​genesys_users_post_group_members

​genesys_users_post_groups

​genesys_users_post_groups_search

​genesys_users_post_locations_search

​genesys_users_post_presence_definitions

​genesys_users_post_presence_sources

​genesys_users_post_search

​genesys_users_post_search

​genesys_users_post_search_suggest

​genesys_users_post_search_teams_assign

​genesys_users_post_speechandtextanalytics_transcripts_search

​genesys_users_post_team_members

​genesys_users_post_teams

Tools

genesys_users_delete_group

genesys_users_delete_group_members

genesys_users_delete_presence_definition

genesys_users_delete_presence_source

genesys_users_delete_team

genesys_users_delete_team_members

genesys_users_delete_user

genesys_users_delete_user_station_associatedstation

genesys_users_delete_user_station_defaultstation

genesys_users_get_authorization_divisionspermitted_paged_me

genesys_users_get_documentation_gkn_search

genesys_users_get_documentation_search

genesys_users_get_group

genesys_users_get_group_individuals

genesys_users_get_group_members

genesys_users_get_groups

genesys_users_get_groups_search

genesys_users_get_locations_search

genesys_users_get_me

genesys_users_get_presence_definition

genesys_users_get_presence_definitions

genesys_users_get_presence_settings

genesys_users_get_presence_source

genesys_users_get_presence_sources

genesys_users_get_presence_user_primarysource

genesys_users_get_search

genesys_users_get_search

genesys_users_get_search_suggest

genesys_users_get_systempresences

genesys_users_get_team

genesys_users_get_team_members

genesys_users_get_teams

genesys_users_get_telephony_providers_edges_sites_search

genesys_users_get_user

genesys_users_get_user_callforwarding

genesys_users_get_user_directreports

genesys_users_get_user_geolocation

genesys_users_get_user_outofoffice

genesys_users_get_user_presence

genesys_users_get_user_presences_purecloud

genesys_users_get_user_profileskills

genesys_users_get_user_queues

genesys_users_get_user_roles

genesys_users_get_user_routinglanguages

genesys_users_get_user_routingskills

genesys_users_get_user_routingstatus

genesys_users_get_user_state

genesys_users_get_user_station

genesys_users_get_user_superiors

genesys_users_get_user_trustors

genesys_users_get_users

genesys_users_get_users_me

genesys_users_get_users_presences_purecloud_bulk

genesys_users_get_voicemail_search

genesys_users_patch_team

genesys_users_patch_user

genesys_users_patch_user_callforwarding

genesys_users_patch_user_geolocation

genesys_users_patch_user_presence

genesys_users_patch_user_presences_purecloud

genesys_users_post_documentation_gkn_search

genesys_users_post_documentation_search

genesys_users_post_group_members

genesys_users_post_groups

genesys_users_post_groups_search

genesys_users_post_locations_search

genesys_users_post_presence_definitions

genesys_users_post_presence_sources

genesys_users_post_search

genesys_users_post_search

genesys_users_post_search_suggest

genesys_users_post_search_teams_assign

genesys_users_post_speechandtextanalytics_transcripts_search

genesys_users_post_team_members

genesys_users_post_teams

genesys_users_post_teams_search

genesys_users_post_telephony_providers_edges_sites_search

genesys_users_post_users

genesys_users_post_users_search