/genesys-case-management | Type: Application | PCID required: Yes
Tools
genesys-case-management_delete_case
Delete a Case. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | Case identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseId": {
"type": "string",
"description": "Case identifier."
}
},
"required": [
"PCID",
"caseId"
]
}
genesys-case-management_delete_caseplan
Delete a Caseplan. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
}
},
"required": [
"PCID",
"caseplanId"
]
}
genesys-case-management_delete_caseplan_dataschema
Remove a data schema from a draft Caseplan. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
schemaKeyName | string | Yes | — | Schema key (for example “default”). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
},
"schemaKeyName": {
"type": "string",
"description": "Schema key (for example \"default\")."
}
},
"required": [
"PCID",
"caseplanId",
"schemaKeyName"
]
}
genesys-case-management_get_association
Get a Case Association. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | Case identifier. |
associationId | string | Yes | — | Case association identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseId": {
"type": "string",
"description": "Case identifier."
},
"associationId": {
"type": "string",
"description": "Case association identifier."
}
},
"required": [
"PCID",
"caseId",
"associationId"
]
}
genesys-case-management_get_associations
Get a list of Case associations for the Case. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | Case identifier. |
before | string | No | — | The cursor that points to the start of the set of entities that has been returned. |
after | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
pageSize | string | No | — | Number of entities to return. Maximum of 200. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseId": {
"type": "string",
"description": "Case identifier."
},
"before": {
"type": "string",
"description": "The cursor that points to the start of the set of entities that has been returned."
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "string",
"description": "Number of entities to return. Maximum of 200."
}
},
"required": [
"PCID",
"caseId"
]
}
genesys-case-management_get_case
Get a Case. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | Case identifier. |
expands | string | No | — | Fields to expand. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseId": {
"type": "string",
"description": "Case identifier."
},
"expands": {
"type": "string",
"description": "Fields to expand.",
"enum": [
"caseplan"
]
}
},
"required": [
"PCID",
"caseId"
]
}
genesys-case-management_get_caseplan
Get a Caseplan. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
}
},
"required": [
"PCID",
"caseplanId"
]
}
genesys-case-management_get_caseplan_version
Get a Caseplan version. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
versionId | string | Yes | — | Caseplan version identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
},
"versionId": {
"type": "string",
"description": "Caseplan version identifier."
}
},
"required": [
"PCID",
"caseplanId",
"versionId"
]
}
genesys-case-management_get_caseplan_version_dataschemas
Get the data schemas for a Caseplan version. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
versionId | string | Yes | — | Caseplan version identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
},
"versionId": {
"type": "string",
"description": "Caseplan version identifier."
}
},
"required": [
"PCID",
"caseplanId",
"versionId"
]
}
genesys-case-management_get_caseplan_version_intakesettings
Get the intake settings for a Caseplan version. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
versionId | string | Yes | — | Caseplan version identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
},
"versionId": {
"type": "string",
"description": "Caseplan version identifier."
}
},
"required": [
"PCID",
"caseplanId",
"versionId"
]
}
genesys-case-management_get_caseplan_version_stageplan
Get a Stageplan. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
versionId | string | Yes | — | Caseplan version identifier. |
stageplanId | string | Yes | — | Stageplan identifier. |
expands | string[] | No | — | Fields to expand. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
},
"versionId": {
"type": "string",
"description": "Caseplan version identifier."
},
"stageplanId": {
"type": "string",
"description": "Stageplan identifier."
},
"expands": {
"type": "array",
"items": {
"type": "string",
"enum": [
"caseplan"
]
},
"description": "Fields to expand."
}
},
"required": [
"PCID",
"caseplanId",
"versionId",
"stageplanId"
]
}
genesys-case-management_get_caseplan_version_stageplan_stepplan
Get a Stepplan. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
versionId | string | Yes | — | Caseplan version identifier. |
stageplanId | string | Yes | — | Stageplan identifier. |
stepplanId | string | Yes | — | Stepplan identifier. |
expands | string[] | No | — | Fields to expand. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
},
"versionId": {
"type": "string",
"description": "Caseplan version identifier."
},
"stageplanId": {
"type": "string",
"description": "Stageplan identifier."
},
"stepplanId": {
"type": "string",
"description": "Stepplan identifier."
},
"expands": {
"type": "array",
"items": {
"type": "string",
"enum": [
"stageplan",
"caseplan",
"worktype"
]
},
"description": "Fields to expand."
}
},
"required": [
"PCID",
"caseplanId",
"versionId",
"stageplanId",
"stepplanId"
]
}
genesys-case-management_get_caseplan_version_stageplan_stepplans
Get a list of Stepplans. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
versionId | string | Yes | — | Caseplan version identifier. |
stageplanId | string | Yes | — | Stageplan identifier. |
before | string | No | — | The cursor that points to the start of the set of entities that has been returned. |
after | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
pageSize | string | No | — | Number of entities to return. Maximum of 200. |
expands | string[] | No | — | Fields to expand. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
},
"versionId": {
"type": "string",
"description": "Caseplan version identifier."
},
"stageplanId": {
"type": "string",
"description": "Stageplan identifier."
},
"before": {
"type": "string",
"description": "The cursor that points to the start of the set of entities that has been returned."
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "string",
"description": "Number of entities to return. Maximum of 200."
},
"expands": {
"type": "array",
"items": {
"type": "string",
"enum": [
"caseplan",
"stageplan",
"worktype"
]
},
"description": "Fields to expand."
}
},
"required": [
"PCID",
"caseplanId",
"versionId",
"stageplanId"
]
}
genesys-case-management_get_caseplan_version_stageplans
Get a list of Stageplans. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
versionId | string | Yes | — | Caseplan version identifier. |
before | string | No | — | The cursor that points to the start of the set of entities that has been returned. |
after | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
pageSize | string | No | — | Number of entities to return. Maximum of 200. |
expands | string[] | No | — | Fields to expand. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
},
"versionId": {
"type": "string",
"description": "Caseplan version identifier."
},
"before": {
"type": "string",
"description": "The cursor that points to the start of the set of entities that has been returned."
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "string",
"description": "Number of entities to return. Maximum of 200."
},
"expands": {
"type": "array",
"items": {
"type": "string",
"enum": [
"caseplan"
]
},
"description": "Fields to expand."
}
},
"required": [
"PCID",
"caseplanId",
"versionId"
]
}
genesys-case-management_get_caseplans
Get a list of Caseplans. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
after | string | No | — | Cursor that points to the end of the previously returned set of Caseplans. |
pageSize | integer | No | — | Number of Caseplans to return. Maximum is 200. |
customerIntentId | string | No | — | Filter by customer intent. |
divisionIds | string | No | — | Filter by divisions. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"type": "string",
"description": "Cursor that points to the end of the previously returned set of Caseplans."
},
"pageSize": {
"type": "integer",
"description": "Number of Caseplans to return. Maximum is 200."
},
"customerIntentId": {
"type": "string",
"description": "Filter by customer intent."
},
"divisionIds": {
"type": "string",
"description": "Filter by divisions."
}
},
"required": [
"PCID"
]
}
genesys-case-management_get_cases_externalcontact
Get a list of Cases for an External Contact. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalContactId | string | Yes | — | External contact identifier. |
after | string | No | — | Cursor pointing to the end of the previously returned page of Cases. |
pageSize | integer | No | — | Number of Cases to return (maximum 200). |
divisionIds | string | No | — | Filter by divisions. |
expands | string[] | No | — | Fields to expand. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalContactId": {
"type": "string",
"description": "External contact identifier."
},
"after": {
"type": "string",
"description": "Cursor pointing to the end of the previously returned page of Cases."
},
"pageSize": {
"type": "integer",
"description": "Number of Cases to return (maximum 200)."
},
"divisionIds": {
"type": "string",
"description": "Filter by divisions."
},
"expands": {
"type": "array",
"items": {
"type": "string",
"enum": [
"caseplan"
]
},
"description": "Fields to expand."
}
},
"required": [
"PCID",
"externalContactId"
]
}
genesys-case-management_get_cases_reference
Get a Case by reference. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
referenceId | string | Yes | — | Case reference. |
expands | string | No | — | Fields to expand. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"referenceId": {
"type": "string",
"description": "Case reference."
},
"expands": {
"type": "string",
"description": "Fields to expand.",
"enum": [
"caseplan"
]
}
},
"required": [
"PCID",
"referenceId"
]
}
genesys-case-management_get_stage
Get a Stage. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | Case identifier. |
stageId | string | Yes | — | Stage identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseId": {
"type": "string",
"description": "Case identifier."
},
"stageId": {
"type": "string",
"description": "Stage identifier."
}
},
"required": [
"PCID",
"caseId",
"stageId"
]
}
genesys-case-management_get_stage_step
Get a Step. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | Case identifier. |
stageId | string | Yes | — | Stage identifier. |
stepId | string | Yes | — | Step identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseId": {
"type": "string",
"description": "Case identifier."
},
"stageId": {
"type": "string",
"description": "Stage identifier."
},
"stepId": {
"type": "string",
"description": "Step identifier."
}
},
"required": [
"PCID",
"caseId",
"stageId",
"stepId"
]
}
genesys-case-management_get_stage_steps
Get a list of Steps. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | Case identifier. |
stageId | string | Yes | — | Stage identifier. |
before | string | No | — | The cursor that points to the start of the set of entities that has been returned. |
after | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
pageSize | string | No | — | Number of entities to return. Maximum of 200. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseId": {
"type": "string",
"description": "Case identifier."
},
"stageId": {
"type": "string",
"description": "Stage identifier."
},
"before": {
"type": "string",
"description": "The cursor that points to the start of the set of entities that has been returned."
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "string",
"description": "Number of entities to return. Maximum of 200."
}
},
"required": [
"PCID",
"caseId",
"stageId"
]
}
genesys-case-management_get_stages
Get a list of Stages. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | Case identifier. |
before | string | No | — | The cursor that points to the start of the set of entities that has been returned. |
after | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
pageSize | string | No | — | Number of entities to return. Maximum of 200. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseId": {
"type": "string",
"description": "Case identifier."
},
"before": {
"type": "string",
"description": "The cursor that points to the start of the set of entities that has been returned."
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"pageSize": {
"type": "string",
"description": "Number of entities to return. Maximum of 200."
}
},
"required": [
"PCID",
"caseId"
]
}
genesys-case-management_get_terminate_job
Get a Terminate Job for a Case. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | Case identifier. |
jobId | string | Yes | — | Terminate Job identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseId": {
"type": "string",
"description": "Case identifier."
},
"jobId": {
"type": "string",
"description": "Terminate Job identifier."
}
},
"required": [
"PCID",
"caseId",
"jobId"
]
}
genesys-case-management_patch_caseplan
Update the attributes of a Caseplan. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
customerIntentId | string | No | — | The ID of the customer intent associated with this Caseplan. |
defaultCaseOwnerId | string | No | — | The ID of the default owner of a Case created from the Caseplan. Must be a valid UUID. |
defaultDueDurationInSeconds | integer | No | — | The default due duration in seconds for Cases created from the Caseplan. Valid range is between 1 and 31536000 seconds. |
defaultTtlSeconds | integer | No | — | The default TTL in seconds for Cases created from the Caseplan. Valid range is between 86400 and 31536000 seconds. |
description | string | No | — | The description of the Caseplan. Maximum length of 512 characters. |
divisionId | string | No | — | The ID of the division the Caseplan belongs to. If divisionId is null or ’*’, the Caseplan will be divisionless. |
name | string | No | — | The name of the Caseplan. Valid length between 3 and 256 characters. |
referencePrefix | string | No | — | The reference of the Caseplan. Valid length between 2 and 8 alphanumeric characters. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
},
"customerIntentId": {
"type": "string",
"description": "The ID of the customer intent associated with this Caseplan."
},
"defaultCaseOwnerId": {
"type": "string",
"description": "The ID of the default owner of a Case created from the Caseplan. Must be a valid UUID."
},
"defaultDueDurationInSeconds": {
"type": "integer",
"description": "The default due duration in seconds for Cases created from the Caseplan. Valid range is between 1 and 31536000 seconds."
},
"defaultTtlSeconds": {
"type": "integer",
"description": "The default TTL in seconds for Cases created from the Caseplan. Valid range is between 86400 and 31536000 seconds."
},
"description": {
"type": "string",
"description": "The description of the Caseplan. Maximum length of 512 characters."
},
"divisionId": {
"type": "string",
"description": "The ID of the division the Caseplan belongs to. If divisionId is null or '*', the Caseplan will be divisionless."
},
"name": {
"type": "string",
"description": "The name of the Caseplan. Valid length between 3 and 256 characters."
},
"referencePrefix": {
"type": "string",
"description": "The reference of the Caseplan. Valid length between 2 and 8 alphanumeric characters."
}
},
"required": [
"PCID",
"caseplanId"
]
}
genesys-case-management_patch_caseplan_stageplan
Update the attributes of a Stageplan. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
stageplanId | string | Yes | — | Stageplan identifier. |
description | string | No | — | The description of the Stageplan. Maximum length of 512 characters. |
name | string | No | — | The name of the Stageplan. Valid length between 3 and 256 characters. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
},
"stageplanId": {
"type": "string",
"description": "Stageplan identifier."
},
"description": {
"type": "string",
"description": "The description of the Stageplan. Maximum length of 512 characters."
},
"name": {
"type": "string",
"description": "The name of the Stageplan. Valid length between 3 and 256 characters."
}
},
"required": [
"PCID",
"caseplanId",
"stageplanId"
]
}
genesys-case-management_patch_caseplan_stageplan_stepplan
Update the attributes of a Stepplan. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
stageplanId | string | Yes | — | Stageplan identifier. |
stepplanId | string | Yes | — | Stepplan identifier. |
activityType | string | No | — | The activity type of the Stepplan. |
description | string | No | — | The description of the Stepplan. Maximum length of 512 characters. |
name | string | No | — | The name of the Stepplan. Valid length between 3 and 256 characters. |
workitemSettings | object | No | — | Workitem Settings |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
},
"stageplanId": {
"type": "string",
"description": "Stageplan identifier."
},
"stepplanId": {
"type": "string",
"description": "Stepplan identifier."
},
"activityType": {
"type": "string",
"description": "The activity type of the Stepplan.",
"enum": [
"Unknown",
"None",
"Workitem"
]
},
"description": {
"type": "string",
"description": "The description of the Stepplan. Maximum length of 512 characters."
},
"name": {
"type": "string",
"description": "The name of the Stepplan. Valid length between 3 and 256 characters."
},
"workitemSettings": {
"type": "object",
"description": "Workitem Settings",
"properties": {
"worktypeId": {
"type": "string",
"description": "The UUID of the Worktype."
}
}
}
},
"required": [
"PCID",
"caseplanId",
"stageplanId",
"stepplanId"
]
}
genesys-case-management_patch_datedue
Update the due date of a Case. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | Case identifier. |
dateDue | string | Yes | — | The due date of the Case. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseId": {
"type": "string",
"description": "Case identifier."
},
"dateDue": {
"type": "string",
"description": "The due date of the Case. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
}
},
"required": [
"PCID",
"caseId",
"dateDue"
]
}
genesys-case-management_patch_priority
Update priority of a Case. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | Case identifier. |
priority | string | Yes | — | The priority of the Case. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseId": {
"type": "string",
"description": "Case identifier."
},
"priority": {
"type": "string",
"description": "The priority of the Case.",
"enum": [
"Unknown",
"Urgent",
"High",
"Medium",
"Low"
]
}
},
"required": [
"PCID",
"caseId",
"priority"
]
}
genesys-case-management_patch_summary
Update summary of a Case. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | Case identifier. |
summary | string | Yes | — | Overview information for the Case. Valid length between 3 and 512 characters. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseId": {
"type": "string",
"description": "Case identifier."
},
"summary": {
"type": "string",
"description": "Overview information for the Case. Valid length between 3 and 512 characters."
}
},
"required": [
"PCID",
"caseId",
"summary"
]
}
genesys-case-management_post_associations
Create a Case association. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | Case identifier. |
conversationId | string | No | — | The ID of the Conversation to associate with the Case. |
workitemId | string | No | — | The ID of the Workitem to associate with the Case. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseId": {
"type": "string",
"description": "Case identifier."
},
"conversationId": {
"type": "string",
"description": "The ID of the Conversation to associate with the Case."
},
"workitemId": {
"type": "string",
"description": "The ID of the Workitem to associate with the Case."
}
},
"required": [
"PCID",
"caseId"
]
}
genesys-case-management_post_caseplan_dataschemas
Add a data schema to a draft Caseplan. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
id | string | Yes | — | The schema ID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
},
"id": {
"type": "string",
"description": "The schema ID."
}
},
"required": [
"PCID",
"caseplanId",
"id"
]
}
genesys-case-management_post_caseplan_publish
Publish Caseplan. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
}
},
"required": [
"PCID",
"caseplanId"
]
}
genesys-case-management_post_caseplan_versions
Create Caseplan version. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
}
},
"required": [
"PCID",
"caseplanId"
]
}
genesys-case-management_post_caseplans
Create a Caseplan. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
customerIntentId | string | Yes | — | The ID of the customer intent associated with this Caseplan. |
dataSchemas | object[] | No | — | The schemas that define all data for Cases from this Caseplan. The schema must be defined in the TaskManagement namespace. Omit or leave null to create a draft Caseplan without a schema; assign a schema before publish. |
defaultCaseOwnerId | string | No | — | The ID of the default owner of a Case created from the Caseplan. |
defaultDueDurationInSeconds | integer | No | — | The default due duration in seconds for Cases created from the Caseplan. Valid range is between 1 and 31536000 seconds. |
defaultTtlSeconds | integer | No | — | The default TTL in seconds for Cases created from the Caseplan. Valid range is between 86400 and 31536000 seconds. |
description | string | No | — | The description of the Caseplan. Maximum length of 512 characters. |
divisionId | string | Yes | — | The ID of the division the Caseplan belongs to. Use ’*’ for divisionless Caseplans. |
intakeSettings | object[] | No | — | The intake format when collecting data for a Case from this Caseplan. There can be a maximum of 10 IntakeSettings defined for a Caseplan. |
name | string | Yes | — | The name of the Caseplan. Valid length between 3 and 256 characters. |
referencePrefix | string | Yes | — | The prefix of the Caseplan reference. Valid length between 2 and 8 alphanumeric characters. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customerIntentId": {
"type": "string",
"description": "The ID of the customer intent associated with this Caseplan."
},
"dataSchemas": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The schema ID."
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "The URI for this object"
}
},
"required": [
"id"
]
},
"description": "The schemas that define all data for Cases from this Caseplan. The schema must be defined in the TaskManagement namespace. Omit or leave null to create a draft Caseplan without a schema; assign a schema before publish."
},
"defaultCaseOwnerId": {
"type": "string",
"description": "The ID of the default owner of a Case created from the Caseplan."
},
"defaultDueDurationInSeconds": {
"type": "integer",
"description": "The default due duration in seconds for Cases created from the Caseplan. Valid range is between 1 and 31536000 seconds."
},
"defaultTtlSeconds": {
"type": "integer",
"description": "The default TTL in seconds for Cases created from the Caseplan. Valid range is between 86400 and 31536000 seconds."
},
"description": {
"type": "string",
"description": "The description of the Caseplan. Maximum length of 512 characters."
},
"divisionId": {
"type": "string",
"description": "The ID of the division the Caseplan belongs to. Use '*' for divisionless Caseplans."
},
"intakeSettings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string",
"description": "The property name for this intake setting."
},
"required": {
"type": "boolean",
"description": "Whether this property is required for intake."
},
"displayOrder": {
"type": "integer",
"format": "int32",
"description": "The display order for this property."
}
},
"required": [
"displayOrder",
"property",
"required"
]
},
"description": "The intake format when collecting data for a Case from this Caseplan. There can be a maximum of 10 IntakeSettings defined for a Caseplan."
},
"name": {
"type": "string",
"description": "The name of the Caseplan. Valid length between 3 and 256 characters."
},
"referencePrefix": {
"type": "string",
"description": "The prefix of the Caseplan reference. Valid length between 2 and 8 alphanumeric characters."
}
},
"required": [
"PCID",
"customerIntentId",
"divisionId",
"name",
"referencePrefix"
]
}
genesys-case-management_post_caseplans_query
Query for Caseplans. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
after | string | No | — | Cursor for pagination. Use the “after” value from the previous response. |
divisionIds | string[] | No | — | Divisions to filter by. Accepts a list of UUIDs and/or ’*’. |
name | string | No | — | Filter by Caseplan name (case-insensitive, partial match). Omitting name returns all Caseplans (subject to pagination). |
nameSearchType | string | No | — | Type of name search to perform. Default is BEGINS_WITH. |
pageSize | integer | No | — | Number of results per page. Maximum is 200. Default is 25. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"type": "string",
"description": "Cursor for pagination. Use the \"after\" value from the previous response."
},
"divisionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Divisions to filter by. Accepts a list of UUIDs and/or '*'."
},
"name": {
"type": "string",
"description": "Filter by Caseplan name (case-insensitive, partial match). Omitting name returns all Caseplans (subject to pagination)."
},
"nameSearchType": {
"type": "string",
"description": "Type of name search to perform. Default is BEGINS_WITH.",
"enum": [
"BEGINS_WITH",
"CONTAINS"
]
},
"pageSize": {
"type": "integer",
"description": "Number of results per page. Maximum is 200. Default is 25."
}
},
"required": [
"PCID"
]
}
genesys-case-management_post_cases
Create a Case. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | The ID of the Caseplan used to create the Case. |
conversationId | string | No | — | The ID of the Conversation associated with the Case. |
externalContactId | string | Yes | — | The ID of the External Contact associated with the Case. |
intake | object[] | No | — | The intake data for the Case. Maximum of 10 intake objects allowed. |
ownerId | string | No | — | The ID of the owner of the Case. |
summary | string | No | — | Overview information for the Case. Valid length between 3 and 512 characters. |
ttlSeconds | integer | No | — | Epoch timestamp in seconds for the Case time-to-live. Cannot be more than 365 days after the current time. |
workitemId | string | No | — | The ID of the Workitem associated with the Case. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "The ID of the Caseplan used to create the Case."
},
"conversationId": {
"type": "string",
"description": "The ID of the Conversation associated with the Case."
},
"externalContactId": {
"type": "string",
"description": "The ID of the External Contact associated with the Case."
},
"intake": {
"type": "array",
"items": {
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "The intake data containing key-value pairs."
}
}
},
"description": "The intake data for the Case. Maximum of 10 intake objects allowed."
},
"ownerId": {
"type": "string",
"description": "The ID of the owner of the Case."
},
"summary": {
"type": "string",
"description": "Overview information for the Case. Valid length between 3 and 512 characters."
},
"ttlSeconds": {
"type": "integer",
"description": "Epoch timestamp in seconds for the Case time-to-live. Cannot be more than 365 days after the current time."
},
"workitemId": {
"type": "string",
"description": "The ID of the Workitem associated with the Case."
}
},
"required": [
"PCID",
"caseplanId",
"externalContactId"
]
}
genesys-case-management_post_cases_associations_query
Query for Case associations by interaction. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
after | string | No | — | Cursor pointing to the end of the previously returned page of associations. |
conversationId | string | No | — | The Conversation ID to query by. |
pageSize | integer | No | — | The number of entities to return in the response. |
workitemId | string | No | — | The Workitem ID to query by. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"after": {
"type": "string",
"description": "Cursor pointing to the end of the previously returned page of associations."
},
"conversationId": {
"type": "string",
"description": "The Conversation ID to query by."
},
"pageSize": {
"type": "integer",
"description": "The number of entities to return in the response."
},
"workitemId": {
"type": "string",
"description": "The Workitem ID to query by."
}
},
"required": [
"PCID"
]
}
genesys-case-management_post_terminate_jobs
Create a Terminate Job for a Case. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseId | string | Yes | — | Case identifier. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseId": {
"type": "string",
"description": "Case identifier."
}
},
"required": [
"PCID",
"caseId"
]
}
genesys-case-management_put_caseplan_dataschema
Update a data schema on a draft Caseplan. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
schemaKeyName | string | Yes | — | Schema key (for example “default”). |
id | string | Yes | — | The schema ID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
},
"schemaKeyName": {
"type": "string",
"description": "Schema key (for example \"default\")."
},
"id": {
"type": "string",
"description": "The schema ID."
}
},
"required": [
"PCID",
"caseplanId",
"schemaKeyName",
"id"
]
}
genesys-case-management_put_caseplan_intakesettings
Update the intake settings for a Caseplan. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
caseplanId | string | Yes | — | Caseplan identifier. |
intakeSettings | object[] | No | — | The intake settings for the Caseplan. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"caseplanId": {
"type": "string",
"description": "Caseplan identifier."
},
"intakeSettings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string",
"description": "The property name for this intake setting."
},
"required": {
"type": "boolean",
"description": "Whether this property is required for intake."
},
"displayOrder": {
"type": "integer",
"format": "int32",
"description": "The display order for this property."
}
},
"required": [
"displayOrder",
"property",
"required"
]
},
"description": "The intake settings for the Caseplan."
}
},
"required": [
"PCID",
"caseplanId"
]
}

