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

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

Tools

Tool	Description
`genesys_coaching_delete_appointment`	Delete an existing appointment
`genesys_coaching_delete_appointment_annotation`	Delete an existing annotation
`genesys_coaching_delete_learning_assignment`	Delete a learning assignment
`genesys_coaching_delete_learning_module`	Delete a learning module
`genesys_coaching_get_appointment`	Retrieve an appointment
`genesys_coaching_get_appointment_annotation`	Retrieve an annotation.
`genesys_coaching_get_appointment_annotations`	Get a list of annotations.
`genesys_coaching_get_appointment_statuses`	Get the list of status changes for a coaching appointment.
`genesys_coaching_get_appointments`	Get appointments for users and optional date range
`genesys_coaching_get_appointments_me`	Get my appointments for a given date range
`genesys_coaching_get_learning_assignment`	Get Learning Assignment
`genesys_coaching_get_learning_assignment_step`	Get Learning Assignment Step
`genesys_coaching_get_learning_assignments`	List of Learning module Assignments
`genesys_coaching_get_learning_assignments_me`	List of Learning Assignments assigned to current user
`genesys_coaching_get_learning_module`	Get a learning module
`genesys_coaching_get_learning_module_job`	Get a specific Learning Module job status
`genesys_coaching_get_learning_module_preview`	Get a learning module preview
`genesys_coaching_get_learning_module_rule`	Get a learning module rule
`genesys_coaching_get_learning_module_version`	Get specific version of a published module
`genesys_coaching_get_learning_modules`	Get all learning modules of an organization
`genesys_coaching_get_learning_modules_assignments`	Get all learning modules of an organization including assignments for a specific user
`genesys_coaching_get_learning_modules_coverart_cover_art_id`	Get a specific Learning Module cover art using ID
`genesys_coaching_get_learning_scheduleslots_job`	Retrieve the status of the job for the slots where a learning activity can be scheduled.
`genesys_coaching_get_learning_scorm_scorm_id`	Get Learning SCORM Result
`genesys_coaching_get_notification`	Get an existing notification
`genesys_coaching_get_notifications`	Retrieve the list of your notifications.
`genesys_coaching_get_scheduleslots_job`	Retrieve the status of the job for the slots where a coaching appointment can be scheduled.
`genesys_coaching_patch_appointment`	Update an existing appointment
`genesys_coaching_patch_appointment_annotation`	Update an existing annotation.
`genesys_coaching_patch_appointment_status`	Update the status of a coaching appointment
`genesys_coaching_patch_learning_assignment`	Update Learning Assignment
`genesys_coaching_patch_learning_assignment_reschedule`	Reschedule Learning Assignment
`genesys_coaching_patch_learning_assignment_step`	Update Learning Assignment Step
`genesys_coaching_patch_learning_module_user_assignments`	Update an external assignment for a specific user
`genesys_coaching_patch_notification`	Update an existing notification.
`genesys_coaching_post_appointment_annotations`	Create a new annotation.
`genesys_coaching_post_appointment_conversations`	Add a conversation to an appointment
`genesys_coaching_post_appointments`	Create a new appointment
`genesys_coaching_post_appointments_aggregates_query`	Retrieve aggregated appointment data
`genesys_coaching_post_learning_assessments_scoring`	Score learning assessment for preview
`genesys_coaching_post_learning_assignment_reassign`	Reassign Learning Assignment
`genesys_coaching_post_learning_assignment_reset`	Reset Learning Assignment
`genesys_coaching_post_learning_assignments`	Create Learning Assignment
`genesys_coaching_post_learning_assignments_aggregates_query`	Retrieve aggregated assignment data
`genesys_coaching_post_learning_module_jobs`	Starts a specified operation on learning module
`genesys_coaching_post_learning_module_publish`	Publish a Learning module
`genesys_coaching_post_learning_modules`	Create a new learning module
`genesys_coaching_post_learning_rules_query`	Get users for learning module rule
`genesys_coaching_post_learning_scheduleslots_jobs`	Start job to retrieve slots where a learning activity can be scheduled.
`genesys_coaching_post_learning_scheduleslots_query`	Get list of possible slots where a learning activity can be scheduled.
`genesys_coaching_post_learning_scorm`	Create a SCORM package upload request
`genesys_coaching_post_scheduleslots_jobs`	Start job to retrieve the slots where a coaching appointment can be scheduled.
`genesys_coaching_post_scheduleslots_query`	Get list of possible slots where a coaching appointment can be scheduled.
`genesys_coaching_put_learning_module`	Update a learning module
`genesys_coaching_put_learning_module_preview`	Update a learning module preview
`genesys_coaching_put_learning_module_rule`	Update a learning module rule

genesys_coaching_delete_appointment

Delete an existing appointment Parameters:

Parameter	Type	Required	Default	Description
`appointmentId`	string	Yes	—	The ID of the coaching appointment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "appointmentId": {
      "type": "string",
      "description": "The ID of the coaching appointment."
    }
  },
  "required": [
    "PCID",
    "appointmentId"
  ]
}

genesys_coaching_delete_appointment_annotation

Delete an existing annotation Parameters:

Parameter	Type	Required	Default	Description
`appointmentId`	string	Yes	—	The ID of the coaching appointment.
`annotationId`	string	Yes	—	The ID of the annotation.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "appointmentId": {
      "type": "string",
      "description": "The ID of the coaching appointment."
    },
    "annotationId": {
      "type": "string",
      "description": "The ID of the annotation."
    }
  },
  "required": [
    "PCID",
    "appointmentId",
    "annotationId"
  ]
}

genesys_coaching_delete_learning_assignment

Delete a learning assignment Parameters:

Parameter	Type	Required	Default	Description
`assignmentId`	string	Yes	—	The Learning Assignment ID

Show inputSchema

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

genesys_coaching_delete_learning_module

Delete a learning module Parameters:

Parameter	Type	Required	Default	Description
`moduleId`	string	Yes	—	The ID of the learning module

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "moduleId": {
      "type": "string",
      "description": "The ID of the learning module"
    }
  },
  "required": [
    "PCID",
    "moduleId"
  ]
}

genesys_coaching_get_appointment

Retrieve an appointment Parameters:

Parameter	Type	Required	Default	Description
`appointmentId`	string	Yes	—	The ID of the coaching appointment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "appointmentId": {
      "type": "string",
      "description": "The ID of the coaching appointment."
    }
  },
  "required": [
    "PCID",
    "appointmentId"
  ]
}

genesys_coaching_get_appointment_annotation

Retrieve an annotation. Parameters:

Parameter	Type	Required	Default	Description
`appointmentId`	string	Yes	—	The ID of the coaching appointment.
`annotationId`	string	Yes	—	The ID of the annotation.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "appointmentId": {
      "type": "string",
      "description": "The ID of the coaching appointment."
    },
    "annotationId": {
      "type": "string",
      "description": "The ID of the annotation."
    }
  },
  "required": [
    "PCID",
    "appointmentId",
    "annotationId"
  ]
}

genesys_coaching_get_appointment_annotations

Get a list of annotations. Parameters:

Parameter	Type	Required	Default	Description
`appointmentId`	string	Yes	—	The ID of the coaching appointment.
`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"
    },
    "appointmentId": {
      "type": "string",
      "description": "The ID of the coaching appointment."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    }
  },
  "required": [
    "PCID",
    "appointmentId"
  ]
}

genesys_coaching_get_appointment_statuses

Get the list of status changes for a coaching appointment. Parameters:

Parameter	Type	Required	Default	Description
`appointmentId`	string	Yes	—	The ID of the coaching appointment.
`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"
    },
    "appointmentId": {
      "type": "string",
      "description": "The ID of the coaching appointment."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    }
  },
  "required": [
    "PCID",
    "appointmentId"
  ]
}

genesys_coaching_get_appointments

Get appointments for users and optional date range Parameters:

Parameter	Type	Required	Default	Description
`userIds`	any[]	Yes	—	The user IDs for which to retrieve appointments
`interval`	string	No	—	Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`pageNumber`	integer	No	—	Page number
`pageSize`	integer	No	—	Page size
`statuses`	any[]	No	—	Appointment Statuses to filter by
`facilitatorIds`	any[]	No	—	The facilitator IDs for which to retrieve appointments
`sortOrder`	string	No	—	Sort (by due date) either Asc or Desc
`relationships`	any[]	No	—	Relationships to filter by
`completionInterval`	string	No	—	Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`overdue`	string	No	—	Overdue status to filter by
`intervalCondition`	string	No	—	Filter condition for interval

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userIds": {
      "type": "array",
      "description": "The user IDs for which to retrieve appointments"
    },
    "interval": {
      "type": "string",
      "description": "Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "statuses": {
      "type": "array",
      "description": "Appointment Statuses to filter by"
    },
    "facilitatorIds": {
      "type": "array",
      "description": "The facilitator IDs for which to retrieve appointments"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort (by due date) either Asc or Desc",
      "enum": [
        "Desc",
        "Asc"
      ]
    },
    "relationships": {
      "type": "array",
      "description": "Relationships to filter by"
    },
    "completionInterval": {
      "type": "string",
      "description": "Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "overdue": {
      "type": "string",
      "description": "Overdue status to filter by",
      "enum": [
        "True",
        "False",
        "Any"
      ]
    },
    "intervalCondition": {
      "type": "string",
      "description": "Filter condition for interval",
      "enum": [
        "StartsIn",
        "Overlaps"
      ]
    }
  },
  "required": [
    "PCID",
    "userIds"
  ]
}

genesys_coaching_get_appointments_me

Get my appointments for a given date range Parameters:

Parameter	Type	Required	Default	Description
`interval`	string	No	—	Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`pageNumber`	integer	No	—	Page number
`pageSize`	integer	No	—	Page size
`statuses`	any[]	No	—	Appointment Statuses to filter by
`facilitatorIds`	any[]	No	—	The facilitator IDs for which to retrieve appointments
`sortOrder`	string	No	—	Sort (by due date) either Asc or Desc
`relationships`	any[]	No	—	Relationships to filter by
`completionInterval`	string	No	—	Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`overdue`	string	No	—	Overdue status to filter by
`intervalCondition`	string	No	—	Filter condition for interval

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "interval": {
      "type": "string",
      "description": "Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "statuses": {
      "type": "array",
      "description": "Appointment Statuses to filter by"
    },
    "facilitatorIds": {
      "type": "array",
      "description": "The facilitator IDs for which to retrieve appointments"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort (by due date) either Asc or Desc",
      "enum": [
        "Desc",
        "Asc"
      ]
    },
    "relationships": {
      "type": "array",
      "description": "Relationships to filter by"
    },
    "completionInterval": {
      "type": "string",
      "description": "Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "overdue": {
      "type": "string",
      "description": "Overdue status to filter by",
      "enum": [
        "True",
        "False",
        "Any"
      ]
    },
    "intervalCondition": {
      "type": "string",
      "description": "Filter condition for interval",
      "enum": [
        "StartsIn",
        "Overlaps"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_coaching_get_learning_assignment

Get Learning Assignment Parameters:

Parameter	Type	Required	Default	Description
`assignmentId`	string	Yes	—	The ID of Learning Assignment
`expand`	any[]	No	—	Fields to expand in response

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assignmentId": {
      "type": "string",
      "description": "The ID of Learning Assignment"
    },
    "expand": {
      "type": "array",
      "description": "Fields to expand in response"
    }
  },
  "required": [
    "PCID",
    "assignmentId"
  ]
}

genesys_coaching_get_learning_assignment_step

Get Learning Assignment Step Parameters:

Parameter	Type	Required	Default	Description
`assignmentId`	string	Yes	—	The ID of Learning Assignment
`stepId`	string	Yes	—	The ID of Learning Assignment Step
`shareableContentObjectId`	string	No	—	The ID of SCO to load
`defaultShareableContentObject`	string	No	—	The default SCO to retrieve
`expand`	any[]	No	—	Fields to expand in response

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assignmentId": {
      "type": "string",
      "description": "The ID of Learning Assignment"
    },
    "stepId": {
      "type": "string",
      "description": "The ID of Learning Assignment Step"
    },
    "shareableContentObjectId": {
      "type": "string",
      "description": "The ID of SCO to load"
    },
    "defaultShareableContentObject": {
      "type": "string",
      "description": "The default SCO to retrieve",
      "enum": [
        "First",
        "Last",
        "Next"
      ]
    },
    "expand": {
      "type": "array",
      "description": "Fields to expand in response"
    }
  },
  "required": [
    "PCID",
    "assignmentId",
    "stepId"
  ]
}

genesys_coaching_get_learning_assignments

List of Learning module Assignments Parameters:

Parameter	Type	Required	Default	Description
`moduleId`	string	No	—	Specifies the ID of the learning module. Fetch assignments for learning module ID
`interval`	string	No	—	Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`completionInterval`	string	No	—	Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`overdue`	string	No	—	Specifies if only the non-overdue (overdue is “False”) or overdue (overdue is “True”) assignments are returned. If overdue is “Any” or if the overdue parameter is not supplied, all assignments are returned
`pageSize`	integer	No	—	Page size
`pageNumber`	integer	No	—	Page number
`pass`	string	No	—	Specifies if only the failed (pass is “False”) or passed (pass is “True”) assignments (completed with assessment)are returned. If pass is “Any” or if the pass parameter is not supplied, all assignments are returned
`minPercentageScore`	number	No	—	The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)
`maxPercentageScore`	number	No	—	The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)
`sortOrder`	string	No	—	Specifies result set sort order; if not specified, default sort order is descending (Desc)
`sortBy`	string	No	—	Specifies which field to sort the results by, default sort is by recommendedCompletionDate
`userId`	any[]	No	—	Specifies the list of user IDs to be queried, up to 100 user IDs.
`types`	any[]	No	—	Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated
`states`	any[]	No	—	Specifies the assignment states to filter by
`expand`	any[]	No	—	Specifies the expand option for returning additional information

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "moduleId": {
      "type": "string",
      "description": "Specifies the ID of the learning module. Fetch assignments for learning module ID"
    },
    "interval": {
      "type": "string",
      "description": "Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "completionInterval": {
      "type": "string",
      "description": "Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "overdue": {
      "type": "string",
      "description": "Specifies if only the non-overdue (overdue is \"False\") or overdue (overdue is \"True\") assignments are returned. If overdue is \"Any\" or if the overdue parameter is not supplied, all assignments are returned",
      "enum": [
        "True",
        "False",
        "Any"
      ]
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pass": {
      "type": "string",
      "description": "Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") assignments (completed with assessment)are returned. If pass is \"Any\" or if the pass parameter is not supplied, all assignments are returned",
      "enum": [
        "True",
        "False",
        "Any"
      ]
    },
    "minPercentageScore": {
      "type": "number",
      "description": "The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)"
    },
    "maxPercentageScore": {
      "type": "number",
      "description": "The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)"
    },
    "sortOrder": {
      "type": "string",
      "description": "Specifies result set sort order; if not specified, default sort order is descending (Desc)",
      "enum": [
        "Asc",
        "Desc"
      ]
    },
    "sortBy": {
      "type": "string",
      "description": "Specifies which field to sort the results by, default sort is by recommendedCompletionDate",
      "enum": [
        "RecommendedCompletionDate",
        "DateModified"
      ]
    },
    "userId": {
      "type": "array",
      "description": "Specifies the list of user IDs to be queried, up to 100 user IDs."
    },
    "types": {
      "type": "array",
      "description": "Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated"
    },
    "states": {
      "type": "array",
      "description": "Specifies the assignment states to filter by"
    },
    "expand": {
      "type": "array",
      "description": "Specifies the expand option for returning additional information"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_coaching_get_learning_assignments_me

List of Learning Assignments assigned to current user Parameters:

Parameter	Type	Required	Default	Description
`moduleId`	string	No	—	Specifies the ID of the learning module. Fetch assignments for learning module ID
`interval`	string	No	—	Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`completionInterval`	string	No	—	Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`overdue`	string	No	—	Specifies if only the non-overdue (overdue is “False”) or overdue (overdue is “True”) assignments are returned. If overdue is “Any” or if the overdue parameter is not supplied, all assignments are returned
`pageSize`	integer	No	—	Page size
`pageNumber`	integer	No	—	Page number
`pass`	string	No	—	Specifies if only the failed (pass is “False”) or passed (pass is “True”) assignments (completed with assessment)are returned. If pass is “Any” or if the pass parameter is not supplied, all assignments are returned
`minPercentageScore`	number	No	—	The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)
`maxPercentageScore`	number	No	—	The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)
`sortOrder`	string	No	—	Specifies result set sort order; if not specified, default sort order is descending (Desc)
`sortBy`	string	No	—	Specifies which field to sort the results by, default sort is by recommendedCompletionDate
`types`	any[]	No	—	Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated
`states`	any[]	No	—	Specifies the assignment states to filter by
`expand`	any[]	No	—	Specifies the expand option for returning additional information

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "moduleId": {
      "type": "string",
      "description": "Specifies the ID of the learning module. Fetch assignments for learning module ID"
    },
    "interval": {
      "type": "string",
      "description": "Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "completionInterval": {
      "type": "string",
      "description": "Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "overdue": {
      "type": "string",
      "description": "Specifies if only the non-overdue (overdue is \"False\") or overdue (overdue is \"True\") assignments are returned. If overdue is \"Any\" or if the overdue parameter is not supplied, all assignments are returned",
      "enum": [
        "True",
        "False",
        "Any"
      ]
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pass": {
      "type": "string",
      "description": "Specifies if only the failed (pass is \"False\") or passed (pass is \"True\") assignments (completed with assessment)are returned. If pass is \"Any\" or if the pass parameter is not supplied, all assignments are returned",
      "enum": [
        "True",
        "False",
        "Any"
      ]
    },
    "minPercentageScore": {
      "type": "number",
      "description": "The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)"
    },
    "maxPercentageScore": {
      "type": "number",
      "description": "The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive)"
    },
    "sortOrder": {
      "type": "string",
      "description": "Specifies result set sort order; if not specified, default sort order is descending (Desc)",
      "enum": [
        "Asc",
        "Desc"
      ]
    },
    "sortBy": {
      "type": "string",
      "description": "Specifies which field to sort the results by, default sort is by recommendedCompletionDate",
      "enum": [
        "RecommendedCompletionDate",
        "DateModified"
      ]
    },
    "types": {
      "type": "array",
      "description": "Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated"
    },
    "states": {
      "type": "array",
      "description": "Specifies the assignment states to filter by"
    },
    "expand": {
      "type": "array",
      "description": "Specifies the expand option for returning additional information"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_coaching_get_learning_module

Get a learning module Parameters:

Parameter	Type	Required	Default	Description
`moduleId`	string	Yes	—	The ID of the learning module
`expand`	any[]	No	—	Fields to expand in response(case insensitive)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "moduleId": {
      "type": "string",
      "description": "The ID of the learning module"
    },
    "expand": {
      "type": "array",
      "description": "Fields to expand in response(case insensitive)"
    }
  },
  "required": [
    "PCID",
    "moduleId"
  ]
}

genesys_coaching_get_learning_module_job

Get a specific Learning Module job status Parameters:

Parameter	Type	Required	Default	Description
`moduleId`	string	Yes	—	The ID of the learning module
`jobId`	string	Yes	—	The ID of the learning module job

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "moduleId": {
      "type": "string",
      "description": "The ID of the learning module"
    },
    "jobId": {
      "type": "string",
      "description": "The ID of the learning module job"
    }
  },
  "required": [
    "PCID",
    "moduleId",
    "jobId"
  ]
}

genesys_coaching_get_learning_module_preview

Get a learning module preview Parameters:

Parameter	Type	Required	Default	Description
`moduleId`	string	Yes	—	The ID of the learning module

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "moduleId": {
      "type": "string",
      "description": "The ID of the learning module"
    }
  },
  "required": [
    "PCID",
    "moduleId"
  ]
}

genesys_coaching_get_learning_module_rule

Get a learning module rule Parameters:

Parameter	Type	Required	Default	Description
`moduleId`	string	Yes	—	The ID of the learning module

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "moduleId": {
      "type": "string",
      "description": "The ID of the learning module"
    }
  },
  "required": [
    "PCID",
    "moduleId"
  ]
}

genesys_coaching_get_learning_module_version

Get specific version of a published module Parameters:

Parameter	Type	Required	Default	Description
`moduleId`	string	Yes	—	The ID of the learning module
`versionId`	string	Yes	—	The version of learning module
`expand`	any[]	No	—	Fields to expand in response(case insensitive)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "moduleId": {
      "type": "string",
      "description": "The ID of the learning module"
    },
    "versionId": {
      "type": "string",
      "description": "The version of learning module"
    },
    "expand": {
      "type": "array",
      "description": "Fields to expand in response(case insensitive)"
    }
  },
  "required": [
    "PCID",
    "moduleId",
    "versionId"
  ]
}

genesys_coaching_get_learning_modules

Get all learning modules of an organization Parameters:

Parameter	Type	Required	Default	Description
`isArchived`	boolean	No	—	Archive status
`types`	any[]	No	—	Specifies the module types. Informational, AssessedContent and Assessment are deprecated
`pageSize`	integer	No	—	Page size
`pageNumber`	integer	No	—	Page number
`sortOrder`	string	No	—	Sort order
`sortBy`	string	No	—	Sort by
`searchTerm`	string	No	—	Search Term (searchable by name)
`expand`	any[]	No	—	Fields to expand in response(case insensitive)
`isPublished`	string	No	—	Specifies if only the Unpublished (isPublished is “False”) or Published (isPublished is “True”) modules are returned. If isPublished is “Any” or omitted, both types are returned
`statuses`	any[]	No	—	Specifies the module statuses to filter by
`externalIds`	any[]	No	—	Specifies the module external IDs to filter by. Only one ID is allowed

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "isArchived": {
      "type": "boolean",
      "description": "Archive status"
    },
    "types": {
      "type": "array",
      "description": "Specifies the module types. Informational, AssessedContent and Assessment are deprecated"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sort order",
      "enum": [
        "ascending",
        "descending"
      ]
    },
    "sortBy": {
      "type": "string",
      "description": "Sort by",
      "enum": [
        "name",
        "createddate",
        "percentpassed",
        "averagescore"
      ]
    },
    "searchTerm": {
      "type": "string",
      "description": "Search Term (searchable by name)"
    },
    "expand": {
      "type": "array",
      "description": "Fields to expand in response(case insensitive)"
    },
    "isPublished": {
      "type": "string",
      "description": "Specifies if only the Unpublished (isPublished is \"False\") or Published (isPublished is \"True\") modules are returned. If isPublished is \"Any\" or omitted, both types are returned",
      "enum": [
        "True",
        "False",
        "Any"
      ]
    },
    "statuses": {
      "type": "array",
      "description": "Specifies the module statuses to filter by"
    },
    "externalIds": {
      "type": "array",
      "description": "Specifies the module external IDs to filter by. Only one ID is allowed"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_coaching_get_learning_modules_assignments

Get all learning modules of an organization including assignments for a specific user Parameters:

Parameter	Type	Required	Default	Description
`userIds`	any[]	Yes	—	The IDs of the users to include
`pageSize`	integer	No	—	Page size
`pageNumber`	integer	No	—	Page number
`searchTerm`	string	No	—	Search Term (searches by name and description)
`overdue`	string	No	—	Specifies if only modules with overdue/not overdue (overdue is “True” or “False”) assignments are returned. If overdue is “Any” or omitted, both are returned and can including modules that are unassigned.
`assignmentStates`	any[]	No	—	Specifies the assignment states to return.
`expand`	any[]	No	—	Fields to expand in response(case insensitive)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userIds": {
      "type": "array",
      "description": "The IDs of the users to include"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "searchTerm": {
      "type": "string",
      "description": "Search Term (searches by name and description)"
    },
    "overdue": {
      "type": "string",
      "description": "Specifies if only modules with overdue/not overdue (overdue is \"True\" or \"False\") assignments are returned. If overdue is \"Any\" or omitted, both are returned and can including modules that are unassigned.",
      "enum": [
        "True",
        "False",
        "Any"
      ]
    },
    "assignmentStates": {
      "type": "array",
      "description": "Specifies the assignment states to return."
    },
    "expand": {
      "type": "array",
      "description": "Fields to expand in response(case insensitive)"
    }
  },
  "required": [
    "PCID",
    "userIds"
  ]
}

genesys_coaching_get_learning_modules_coverart_cover_art_id

Get a specific Learning Module cover art using ID Parameters:

Parameter	Type	Required	Default	Description
`coverArtId`	string	Yes	—	Key identifier for the cover art

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "coverArtId": {
      "type": "string",
      "description": "Key identifier for the cover art"
    }
  },
  "required": [
    "PCID",
    "coverArtId"
  ]
}

genesys_coaching_get_learning_scheduleslots_job

Retrieve the status of the job for the slots where a learning activity can be scheduled. Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	The ID of the job

Show inputSchema

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

genesys_coaching_get_learning_scorm_scorm_id

Get Learning SCORM Result Parameters:

Parameter	Type	Required	Default	Description
`scormId`	string	Yes	—	The ID of the SCORM package

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "scormId": {
      "type": "string",
      "description": "The ID of the SCORM package"
    }
  },
  "required": [
    "PCID",
    "scormId"
  ]
}

genesys_coaching_get_notification

Get an existing notification Parameters:

Parameter	Type	Required	Default	Description
`notificationId`	string	Yes	—	The ID of the notification.
`expand`	any[]	No	—	Indicates a field in the response which should be expanded.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "notificationId": {
      "type": "string",
      "description": "The ID of the notification."
    },
    "expand": {
      "type": "array",
      "description": "Indicates a field in the response which should be expanded."
    }
  },
  "required": [
    "PCID",
    "notificationId"
  ]
}

genesys_coaching_get_notifications

Retrieve the list of your notifications. Parameters:

Parameter	Type	Required	Default	Description
`pageNumber`	integer	No	—	Page number
`pageSize`	integer	No	—	Page size
`expand`	any[]	No	—	Indicates a field in the response which should be expanded.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    },
    "expand": {
      "type": "array",
      "description": "Indicates a field in the response which should be expanded."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_coaching_get_scheduleslots_job

Retrieve the status of the job for the slots where a coaching appointment can be scheduled. Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	The ID of job

Show inputSchema

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

genesys_coaching_patch_appointment

Update an existing appointment Parameters:

Parameter	Type	Required	Default	Description
`appointmentId`	string	Yes	—	The ID of the coaching appointment.
`addToSchedule`	boolean	No	—	If True, adds the appointment to their schedule
`conversationIds`	any[]	No	—	IDs of conversations associated with this coaching appointment.
`dateStart`	string	No	—	The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`description`	string	No	—	The description of coaching appointment.
`documentIds`	any[]	No	—	IDs of documents associated with this coaching appointment.
`externalLinks`	any[]	No	—	The list of external links related to the appointment
`lengthInMinutes`	integer	No	—	The duration of coaching appointment in minutes.
`location`	string	No	—	The location of the appointment
`name`	string	No	—	The name of coaching appointment.
`shareInsightsData`	boolean	No	—	Whether to share the insight data
`status`	string	No	—	The status of the coaching appointment.
`wfmSchedule`	object	No	—	wfmSchedule

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "appointmentId": {
      "type": "string",
      "description": "The ID of the coaching appointment."
    },
    "addToSchedule": {
      "type": "boolean",
      "description": "If True, adds the appointment to their schedule"
    },
    "conversationIds": {
      "type": "array",
      "description": "IDs of conversations associated with this coaching appointment."
    },
    "dateStart": {
      "type": "string",
      "description": "The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "description": {
      "type": "string",
      "description": "The description of coaching appointment."
    },
    "documentIds": {
      "type": "array",
      "description": "IDs of documents associated with this coaching appointment."
    },
    "externalLinks": {
      "type": "array",
      "description": "The list of external links related to the appointment"
    },
    "lengthInMinutes": {
      "type": "integer",
      "description": "The duration of coaching appointment in minutes."
    },
    "location": {
      "type": "string",
      "description": "The location of the appointment"
    },
    "name": {
      "type": "string",
      "description": "The name of coaching appointment."
    },
    "shareInsightsData": {
      "type": "boolean",
      "description": "Whether to share the insight data"
    },
    "status": {
      "type": "string",
      "description": "The status of the coaching appointment.",
      "enum": [
        "Scheduled",
        "InProgress",
        "Completed"
      ]
    },
    "wfmSchedule": {
      "type": "object",
      "description": "wfmSchedule"
    }
  },
  "required": [
    "PCID",
    "appointmentId"
  ]
}

genesys_coaching_patch_appointment_annotation

Update an existing annotation. Parameters:

Parameter	Type	Required	Default	Description
`appointmentId`	string	Yes	—	The ID of the coaching appointment.
`annotationId`	string	Yes	—	The ID of the annotation.
`accessType`	string	No	—	Determines the permissions required to view this item.
`createdBy`	object	No	—	createdBy
`dateCreated`	string	No	—	The date/time the annotation was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`dateModified`	string	No	—	The date/time the annotation was last modified. 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.
`isDeleted`	boolean	No	—	Flag indicating whether the annotation is deleted.
`modifiedBy`	object	No	—	modifiedBy
`selfUri`	string	No	—	The URI for this object
`text`	string	Yes	—	The text of the annotation.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "appointmentId": {
      "type": "string",
      "description": "The ID of the coaching appointment."
    },
    "annotationId": {
      "type": "string",
      "description": "The ID of the annotation."
    },
    "accessType": {
      "type": "string",
      "description": "Determines the permissions required to view this item.",
      "enum": [
        "Public",
        "Private"
      ]
    },
    "createdBy": {
      "type": "object",
      "description": "createdBy"
    },
    "dateCreated": {
      "type": "string",
      "description": "The date/time the annotation was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "dateModified": {
      "type": "string",
      "description": "The date/time the annotation was last modified. 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."
    },
    "isDeleted": {
      "type": "boolean",
      "description": "Flag indicating whether the annotation is deleted."
    },
    "modifiedBy": {
      "type": "object",
      "description": "modifiedBy"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "text": {
      "type": "string",
      "description": "The text of the annotation."
    }
  },
  "required": [
    "PCID",
    "appointmentId",
    "annotationId",
    "text"
  ]
}

genesys_coaching_patch_appointment_status

Update the status of a coaching appointment Parameters:

Parameter	Type	Required	Default	Description
`appointmentId`	string	Yes	—	The ID of the coaching appointment.
`status`	string	Yes	—	The status of the coaching appointment

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "appointmentId": {
      "type": "string",
      "description": "The ID of the coaching appointment."
    },
    "status": {
      "type": "string",
      "description": "The status of the coaching appointment",
      "enum": [
        "Scheduled",
        "InProgress",
        "Completed"
      ]
    }
  },
  "required": [
    "PCID",
    "appointmentId",
    "status"
  ]
}

genesys_coaching_patch_learning_assignment

Update Learning Assignment Parameters:

Parameter	Type	Required	Default	Description
`assignmentId`	string	Yes	—	The ID of Learning Assignment
`assessment`	object	No	—	assessment
`state`	string	No	—	The Learning Assignment state

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assignmentId": {
      "type": "string",
      "description": "The ID of Learning Assignment"
    },
    "assessment": {
      "type": "object",
      "description": "assessment"
    },
    "state": {
      "type": "string",
      "description": "The Learning Assignment state",
      "enum": [
        "Assigned",
        "InProgress",
        "Completed",
        "Deleted",
        "NotCompleted",
        "InvalidSchedule"
      ]
    }
  },
  "required": [
    "PCID",
    "assignmentId"
  ]
}

genesys_coaching_patch_learning_assignment_reschedule

Reschedule Learning Assignment Parameters:

Parameter	Type	Required	Default	Description
`assignmentId`	string	Yes	—	The ID of Learning Assignment
`addToSchedule`	boolean	No	—	If True, adds the assignment to their schedule
`dateRecommendedForCompletion`	string	No	—	The recommended completion date of the assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`lengthInMinutes`	integer	No	—	The length in minutes of the assignment

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assignmentId": {
      "type": "string",
      "description": "The ID of Learning Assignment"
    },
    "addToSchedule": {
      "type": "boolean",
      "description": "If True, adds the assignment to their schedule"
    },
    "dateRecommendedForCompletion": {
      "type": "string",
      "description": "The recommended completion date of the assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "lengthInMinutes": {
      "type": "integer",
      "description": "The length in minutes of the assignment"
    }
  },
  "required": [
    "PCID",
    "assignmentId"
  ]
}

genesys_coaching_patch_learning_assignment_step

Update Learning Assignment Step Parameters:

Parameter	Type	Required	Default	Description
`assignmentId`	string	Yes	—	The ID of Learning Assignment
`stepId`	string	Yes	—	The ID of Learning Assignment Step
`completionPercentage`	number	No	—	The completion percentage for this step
`completionStatus`	string	No	—	The completion status of the assignment step
`id`	string	No	—	The ID of the learning assignment step
`moduleStep`	object	No	—	moduleStep
`percentageScore`	number	No	—	The percentage score for this step
`selfUri`	string	No	—	The URI for this object
`shareableContentObject`	object	No	—	Learning assignment SCO (Shareable Content Object)
`signedCookie`	object	No	—	signedCookie
`structure`	any[]	No	—	The structure for any SCO associated with this step
`successStatus`	string	No	—	The success status of this step

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assignmentId": {
      "type": "string",
      "description": "The ID of Learning Assignment"
    },
    "stepId": {
      "type": "string",
      "description": "The ID of Learning Assignment Step"
    },
    "completionPercentage": {
      "type": "number",
      "description": "The completion percentage for this step"
    },
    "completionStatus": {
      "type": "string",
      "description": "The completion status of the assignment step",
      "enum": [
        "Completed",
        "Incomplete",
        "NotAttempted",
        "Unknown"
      ]
    },
    "id": {
      "type": "string",
      "description": "The ID of the learning assignment step"
    },
    "moduleStep": {
      "type": "object",
      "description": "moduleStep"
    },
    "percentageScore": {
      "type": "number",
      "description": "The percentage score for this step"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "shareableContentObject": {
      "type": "object",
      "description": "Learning assignment SCO (Shareable Content Object)"
    },
    "signedCookie": {
      "type": "object",
      "description": "signedCookie"
    },
    "structure": {
      "type": "array",
      "description": "The structure for any SCO associated with this step"
    },
    "successStatus": {
      "type": "string",
      "description": "The success status of this step",
      "enum": [
        "Passed",
        "Failed",
        "Unknown"
      ]
    }
  },
  "required": [
    "PCID",
    "assignmentId",
    "stepId"
  ]
}

genesys_coaching_patch_learning_module_user_assignments

Update an external assignment for a specific user Parameters:

Parameter	Type	Required	Default	Description
`moduleId`	string	Yes	—	Key identifier for the module
`userId`	string	Yes	—	Key identifier for the user
`isPassed`	boolean	No	—	Was the assignment marked as passed
`percentageScore`	number	No	—	The score
`state`	string	No	—	The Learning Assignment state

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "moduleId": {
      "type": "string",
      "description": "Key identifier for the module"
    },
    "userId": {
      "type": "string",
      "description": "Key identifier for the user"
    },
    "isPassed": {
      "type": "boolean",
      "description": "Was the assignment marked as passed"
    },
    "percentageScore": {
      "type": "number",
      "description": "The score"
    },
    "state": {
      "type": "string",
      "description": "The Learning Assignment state",
      "enum": [
        "Assigned",
        "InProgress",
        "Completed",
        "Deleted",
        "NotCompleted",
        "InvalidSchedule"
      ]
    }
  },
  "required": [
    "PCID",
    "moduleId",
    "userId"
  ]
}

genesys_coaching_patch_notification

Update an existing notification. Parameters:

Parameter	Type	Required	Default	Description
`notificationId`	string	Yes	—	The ID of the notification.
`actionType`	string	No	—	Action causing the notification.
`appointment`	object	No	—	Coaching appointment response
`dateStart`	string	No	—	The start time of the appointment relating to this notification. 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.
`lengthInMinutes`	integer	No	—	The duration of the appointment on this notification
`markedAsRead`	boolean	No	—	Indicates if notification is read or unread
`name`	string	No	—	The name of the appointment for this notification.
`relationship`	string	No	—	The relationship of this user to this notification’s appointment
`selfUri`	string	No	—	The URI for this object
`status`	string	No	—	The status of the appointment for this notification
`user`	object	No	—	user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "notificationId": {
      "type": "string",
      "description": "The ID of the notification."
    },
    "actionType": {
      "type": "string",
      "description": "Action causing the notification.",
      "enum": [
        "Create",
        "Update",
        "Delete",
        "StatusChange"
      ]
    },
    "appointment": {
      "type": "object",
      "description": "Coaching appointment response"
    },
    "dateStart": {
      "type": "string",
      "description": "The start time of the appointment relating to this notification. 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."
    },
    "lengthInMinutes": {
      "type": "integer",
      "description": "The duration of the appointment on this notification"
    },
    "markedAsRead": {
      "type": "boolean",
      "description": "Indicates if notification is read or unread"
    },
    "name": {
      "type": "string",
      "description": "The name of the appointment for this notification."
    },
    "relationship": {
      "type": "string",
      "description": "The relationship of this user to this notification's appointment",
      "enum": [
        "Attendee",
        "Creator",
        "Facilitator"
      ]
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "status": {
      "type": "string",
      "description": "The status of the appointment for this notification",
      "enum": [
        "Scheduled",
        "InProgress",
        "Completed",
        "InvalidSchedule"
      ]
    },
    "user": {
      "type": "object",
      "description": "user"
    }
  },
  "required": [
    "PCID",
    "notificationId"
  ]
}

genesys_coaching_post_appointment_annotations

Create a new annotation. Parameters:

Parameter	Type	Required	Default	Description
`appointmentId`	string	Yes	—	The ID of the coaching appointment.
`accessType`	string	Yes	—	Determines the permissions required to view this item.
`text`	string	Yes	—	The text of the annotation.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "appointmentId": {
      "type": "string",
      "description": "The ID of the coaching appointment."
    },
    "accessType": {
      "type": "string",
      "description": "Determines the permissions required to view this item.",
      "enum": [
        "Public",
        "Private"
      ]
    },
    "text": {
      "type": "string",
      "description": "The text of the annotation."
    }
  },
  "required": [
    "PCID",
    "appointmentId",
    "accessType",
    "text"
  ]
}

genesys_coaching_post_appointment_conversations

Add a conversation to an appointment Parameters:

Parameter	Type	Required	Default	Description
`appointmentId`	string	Yes	—	The ID of the coaching appointment.
`conversationId`	string	Yes	—	The id of the conversation to add

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "appointmentId": {
      "type": "string",
      "description": "The ID of the coaching appointment."
    },
    "conversationId": {
      "type": "string",
      "description": "The id of the conversation to add"
    }
  },
  "required": [
    "PCID",
    "appointmentId",
    "conversationId"
  ]
}

genesys_coaching_post_appointments

Create a new appointment Parameters:

Parameter	Type	Required	Default	Description
`addToSchedule`	boolean	No	—	If True, adds the appointment to their schedule
`attendeeIds`	any[]	Yes	—	IDs of attendees in the coaching appointment.
`conversationIds`	any[]	No	—	IDs of conversations associated with this coaching appointment.
`dateStart`	string	Yes	—	The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`description`	string	Yes	—	The description of coaching appointment.
`documentIds`	any[]	No	—	IDs of documents associated with this coaching appointment.
`externalLinks`	any[]	No	—	The list of external links related to the appointment
`facilitatorId`	string	No	—	The facilitator ID of coaching appointment.
`lengthInMinutes`	integer	Yes	—	The duration of coaching appointment in minutes.
`location`	string	No	—	The location of the appointment
`name`	string	Yes	—	The name of coaching appointment.
`shareInsightsData`	boolean	No	—	Whether to share the insight data
`wfmSchedule`	object	No	—	wfmSchedule

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "addToSchedule": {
      "type": "boolean",
      "description": "If True, adds the appointment to their schedule"
    },
    "attendeeIds": {
      "type": "array",
      "description": "IDs of attendees in the coaching appointment."
    },
    "conversationIds": {
      "type": "array",
      "description": "IDs of conversations associated with this coaching appointment."
    },
    "dateStart": {
      "type": "string",
      "description": "The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "description": {
      "type": "string",
      "description": "The description of coaching appointment."
    },
    "documentIds": {
      "type": "array",
      "description": "IDs of documents associated with this coaching appointment."
    },
    "externalLinks": {
      "type": "array",
      "description": "The list of external links related to the appointment"
    },
    "facilitatorId": {
      "type": "string",
      "description": "The facilitator ID of coaching appointment."
    },
    "lengthInMinutes": {
      "type": "integer",
      "description": "The duration of coaching appointment in minutes."
    },
    "location": {
      "type": "string",
      "description": "The location of the appointment"
    },
    "name": {
      "type": "string",
      "description": "The name of coaching appointment."
    },
    "shareInsightsData": {
      "type": "boolean",
      "description": "Whether to share the insight data"
    },
    "wfmSchedule": {
      "type": "object",
      "description": "wfmSchedule"
    }
  },
  "required": [
    "PCID",
    "attendeeIds",
    "dateStart",
    "description",
    "lengthInMinutes",
    "name"
  ]
}

genesys_coaching_post_appointments_aggregates_query

Retrieve aggregated appointment data Parameters:

Parameter	Type	Required	Default	Description
`filter`	object	Yes	—	filter
`groupBy`	any[]	No	—	An optional list of items by which to group the result data.
`interval`	string	Yes	—	Interval to aggregate across. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	No	—	A list of metrics to aggregate. If omitted, all metrics are returned.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "groupBy": {
      "type": "array",
      "description": "An optional list of items by which to group the result data."
    },
    "interval": {
      "type": "string",
      "description": "Interval to aggregate across. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "A list of metrics to aggregate.  If omitted, all metrics are returned."
    }
  },
  "required": [
    "PCID",
    "filter",
    "interval"
  ]
}

genesys_coaching_post_learning_assessments_scoring

Score learning assessment for preview Parameters:

Parameter	Type	Required	Default	Description
`answers`	object	Yes	—	answers
`assessmentForm`	object	Yes	—	assessmentForm

Show inputSchema

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

genesys_coaching_post_learning_assignment_reassign

Reassign Learning Assignment Parameters:

Parameter	Type	Required	Default	Description
`assignmentId`	string	Yes	—	The Learning Assignment ID

Show inputSchema

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

genesys_coaching_post_learning_assignment_reset

Reset Learning Assignment Parameters:

Parameter	Type	Required	Default	Description
`assignmentId`	string	Yes	—	The Learning Assignment ID

Show inputSchema

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

genesys_coaching_post_learning_assignments

Create Learning Assignment Parameters:

Parameter	Type	Required	Default	Description
`addToSchedule`	boolean	No	—	If True, adds the assignment to their schedule
`lengthInMinutes`	integer	No	—	The length in minutes of assignment
`moduleId`	string	No	—	The Learning module Id associated with this assignment
`recommendedCompletionDate`	string	No	—	The recommended completion date of assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`userId`	string	No	—	The User for whom the assignment is assigned

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "addToSchedule": {
      "type": "boolean",
      "description": "If True, adds the assignment to their schedule"
    },
    "lengthInMinutes": {
      "type": "integer",
      "description": "The length in minutes of assignment"
    },
    "moduleId": {
      "type": "string",
      "description": "The Learning module Id associated with this assignment"
    },
    "recommendedCompletionDate": {
      "type": "string",
      "description": "The recommended completion date of assignment. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "userId": {
      "type": "string",
      "description": "The User for whom the assignment is assigned"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_coaching_post_learning_assignments_aggregates_query

Retrieve aggregated assignment data Parameters:

Parameter	Type	Required	Default	Description
`filter`	object	Yes	—	filter
`groupBy`	any[]	No	—	Specifies if the aggregated data is combined into a single set of metrics (groupBy is empty or not specified), or contains an element per attendeeId (groupBy is “attendeeId”)
`interval`	string	Yes	—	Specifies the range of due dates to be used for filtering. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	No	—	The list of metrics to be returned. If omitted, all metrics are returned.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "groupBy": {
      "type": "array",
      "description": "Specifies if the aggregated data is combined into a single set of metrics (groupBy is empty or not specified), or contains an element per attendeeId (groupBy is \"attendeeId\")"
    },
    "interval": {
      "type": "string",
      "description": "Specifies the range of due dates to be used for filtering. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "The list of metrics to be returned. If omitted, all metrics are returned."
    }
  },
  "required": [
    "PCID",
    "filter",
    "interval"
  ]
}

genesys_coaching_post_learning_module_jobs

Starts a specified operation on learning module Parameters:

Parameter	Type	Required	Default	Description
`moduleId`	string	Yes	—	The ID of the learning module
`action`	string	Yes	—	The type for the learning module job

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "moduleId": {
      "type": "string",
      "description": "The ID of the learning module"
    },
    "action": {
      "type": "string",
      "description": "The type for the learning module job",
      "enum": [
        "Reassign",
        "GracefulArchive",
        "ImmediateArchive",
        "Unarchive",
        "Assign"
      ]
    }
  },
  "required": [
    "PCID",
    "moduleId",
    "action"
  ]
}

genesys_coaching_post_learning_module_publish

Publish a Learning module Parameters:

Parameter	Type	Required	Default	Description
`moduleId`	string	Yes	—	The ID of the learning module
`termsAndConditionsAccepted`	boolean	No	—	Whether the terms and conditions were accepted

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "moduleId": {
      "type": "string",
      "description": "The ID of the learning module"
    },
    "termsAndConditionsAccepted": {
      "type": "boolean",
      "description": "Whether the terms and conditions were accepted"
    }
  },
  "required": [
    "PCID",
    "moduleId"
  ]
}

genesys_coaching_post_learning_modules

Create a new learning module Parameters:

Parameter	Type	Required	Default	Description
`assessmentForm`	object	No	—	assessmentForm
`autoAssign`	object	No	—	Auto assign request
`completionTimeInDays`	integer	Yes	—	The completion time of learning module in days
`coverArt`	object	No	—	coverArt
`description`	string	No	—	The description of learning module
`enforceContentOrder`	boolean	No	—	If true, learning module content should be viewed one by one in order
`excludedFromCatalog`	boolean	No	—	If true, learning module is excluded when retrieving modules for manual assignment
`externalId`	string	No	—	The external ID of the learning module. Maximum length: 50 characters.
`informSteps`	any[]	No	—	The list of inform steps in a learning module
`lengthInMinutes`	integer	No	—	The recommended time in minutes to complete the module
`name`	string	Yes	—	The name of learning module
`reviewAssessmentResults`	object	No	—	reviewAssessmentResults
`type`	string	No	—	The type for the learning module. Informational, AssessedContent and Assessment are deprecated

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "assessmentForm": {
      "type": "object",
      "description": "assessmentForm"
    },
    "autoAssign": {
      "type": "object",
      "description": "Auto assign request"
    },
    "completionTimeInDays": {
      "type": "integer",
      "description": "The completion time of learning module in days"
    },
    "coverArt": {
      "type": "object",
      "description": "coverArt"
    },
    "description": {
      "type": "string",
      "description": "The description of learning module"
    },
    "enforceContentOrder": {
      "type": "boolean",
      "description": "If true, learning module content should be viewed one by one in order"
    },
    "excludedFromCatalog": {
      "type": "boolean",
      "description": "If true, learning module is excluded when retrieving modules for manual assignment"
    },
    "externalId": {
      "type": "string",
      "description": "The external ID of the learning module. Maximum length: 50 characters."
    },
    "informSteps": {
      "type": "array",
      "description": "The list of inform steps in a learning module"
    },
    "lengthInMinutes": {
      "type": "integer",
      "description": "The recommended time in minutes to complete the module"
    },
    "name": {
      "type": "string",
      "description": "The name of learning module"
    },
    "reviewAssessmentResults": {
      "type": "object",
      "description": "reviewAssessmentResults"
    },
    "type": {
      "type": "string",
      "description": "The type for the learning module. Informational, AssessedContent and Assessment are deprecated",
      "enum": [
        "Informational",
        "AssessedContent",
        "Assessment",
        "External",
        "Native"
      ]
    }
  },
  "required": [
    "PCID",
    "completionTimeInDays",
    "name"
  ]
}

genesys_coaching_post_learning_rules_query

Get users for learning module rule Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	Yes	—	Page size
`pageNumber`	integer	Yes	—	Page number
`rule`	object	Yes	—	rule
`searchTerm`	string	No	—	The user name to be searched for

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"
    },
    "rule": {
      "type": "object",
      "description": "rule"
    },
    "searchTerm": {
      "type": "string",
      "description": "The user name to be searched for"
    }
  },
  "required": [
    "PCID",
    "pageSize",
    "pageNumber",
    "rule"
  ]
}

genesys_coaching_post_learning_scheduleslots_jobs

Start job to retrieve slots where a learning activity can be scheduled. Parameters:

Parameter	Type	Required	Default	Description
`activityCodeId`	string	Yes	—	The Activity Code Id of the slots.
`intervals`	any[]	Yes	—	The intervals to fetch the slots for. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`lengthInMinutes`	integer	Yes	—	The length in minutes of the slots, in 15 minutes granularity.
`slotsType`	string	Yes	—	The type of slots to fetch in the job.
`userIds`	any[]	Yes	—	The user IDs to fetch the slots for.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "activityCodeId": {
      "type": "string",
      "description": "The Activity Code Id of the slots."
    },
    "intervals": {
      "type": "array",
      "description": "The intervals to fetch the slots for. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "lengthInMinutes": {
      "type": "integer",
      "description": "The length in minutes of the slots, in 15 minutes granularity."
    },
    "slotsType": {
      "type": "string",
      "description": "The type of slots to fetch in the job.",
      "enum": [
        "BestTime"
      ]
    },
    "userIds": {
      "type": "array",
      "description": "The user IDs to fetch the slots for."
    }
  },
  "required": [
    "PCID",
    "activityCodeId",
    "intervals",
    "lengthInMinutes",
    "slotsType",
    "userIds"
  ]
}

genesys_coaching_post_learning_scheduleslots_query

Get list of possible slots where a learning activity can be scheduled. Parameters:

Parameter	Type	Required	Default	Description
`interruptibleAssignmentId`	string	No	—	Assignment ID to exclude from consideration when determining blocked slots
`interval`	string	Yes	—	Range of time to get slots for scheduling learning activities. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`lengthInMinutes`	integer	Yes	—	The duration of Learning Assignment to schedule in 15 minutes granularity
`userIds`	any[]	Yes	—	The user IDs for which to fetch schedules. Must be only 1.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "interruptibleAssignmentId": {
      "type": "string",
      "description": "Assignment ID to exclude from consideration when determining blocked slots"
    },
    "interval": {
      "type": "string",
      "description": "Range of time to get slots for scheduling learning activities. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "lengthInMinutes": {
      "type": "integer",
      "description": "The duration of Learning Assignment to schedule in 15 minutes granularity"
    },
    "userIds": {
      "type": "array",
      "description": "The user IDs for which to fetch schedules. Must be only 1."
    }
  },
  "required": [
    "PCID",
    "interval",
    "lengthInMinutes",
    "userIds"
  ]
}

genesys_coaching_post_learning_scorm

Create a SCORM package upload request Parameters:

Parameter	Type	Required	Default	Description
`contentMd5`	string	No	—	The MD5 content of the SCORM package

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contentMd5": {
      "type": "string",
      "description": "The MD5 content of the SCORM package"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_coaching_post_scheduleslots_jobs

Start job to retrieve the slots where a coaching appointment can be scheduled. Parameters:

Parameter	Type	Required	Default	Description
`activityCodeId`	string	Yes	—	The Activity Code Id of the slots.
`attendeeIds`	any[]	Yes	—	The attendee IDs to fetch the slots for.
`facilitatorIds`	any[]	No	—	The facilitator IDs to fetch the slots for.
`intervals`	any[]	Yes	—	The intervals to fetch the slots for. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`lengthInMinutes`	integer	Yes	—	The length in minutes of the slots, in 15 minutes granularity.
`slotsType`	string	Yes	—	The type of slots to fetch in the job.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "activityCodeId": {
      "type": "string",
      "description": "The Activity Code Id of the slots."
    },
    "attendeeIds": {
      "type": "array",
      "description": "The attendee IDs to fetch the slots for."
    },
    "facilitatorIds": {
      "type": "array",
      "description": "The facilitator IDs to fetch the slots for."
    },
    "intervals": {
      "type": "array",
      "description": "The intervals to fetch the slots for. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "lengthInMinutes": {
      "type": "integer",
      "description": "The length in minutes of the slots, in 15 minutes granularity."
    },
    "slotsType": {
      "type": "string",
      "description": "The type of slots to fetch in the job.",
      "enum": [
        "BestTime"
      ]
    }
  },
  "required": [
    "PCID",
    "activityCodeId",
    "attendeeIds",
    "intervals",
    "lengthInMinutes",
    "slotsType"
  ]
}

genesys_coaching_post_scheduleslots_query

Get list of possible slots where a coaching appointment can be scheduled. Parameters:

Parameter	Type	Required	Default	Description
`attendeeIds`	any[]	Yes	—	List of attendees to determine coaching appointment slots
`facilitatorIds`	any[]	No	—	List of facilitators to determine coaching appointment slots
`interruptibleAppointmentIds`	any[]	No	—	List of appointment ids to exclude from consideration when determining blocked slots
`interval`	string	Yes	—	Range of time to get slots for scheduling coaching appointments. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`lengthInMinutes`	integer	Yes	—	The duration of coaching appointment to schedule in 15 minutes granularity up to maximum of 60 minutes

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "attendeeIds": {
      "type": "array",
      "description": "List of attendees to determine coaching appointment slots"
    },
    "facilitatorIds": {
      "type": "array",
      "description": "List of facilitators to determine coaching appointment slots"
    },
    "interruptibleAppointmentIds": {
      "type": "array",
      "description": "List of appointment ids to exclude from consideration when determining blocked slots"
    },
    "interval": {
      "type": "string",
      "description": "Range of time to get slots for scheduling coaching appointments. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "lengthInMinutes": {
      "type": "integer",
      "description": "The duration of coaching appointment to schedule in 15 minutes granularity up to maximum of 60 minutes"
    }
  },
  "required": [
    "PCID",
    "attendeeIds",
    "interval",
    "lengthInMinutes"
  ]
}

genesys_coaching_put_learning_module

Update a learning module Parameters:

Parameter	Type	Required	Default	Description
`moduleId`	string	Yes	—	The ID of the learning module
`assessmentForm`	object	No	—	assessmentForm
`autoAssign`	object	No	—	Auto assign request
`completionTimeInDays`	integer	Yes	—	The completion time of learning module in days
`coverArt`	object	No	—	coverArt
`description`	string	No	—	The description of learning module
`enforceContentOrder`	boolean	No	—	If true, learning module content should be viewed one by one in order
`excludedFromCatalog`	boolean	No	—	If true, learning module is excluded when retrieving modules for manual assignment
`externalId`	string	No	—	The external ID of the learning module. Maximum length: 50 characters.
`informSteps`	any[]	No	—	The list of inform steps in a learning module
`lengthInMinutes`	integer	No	—	The recommended time in minutes to complete the module
`name`	string	Yes	—	The name of learning module
`reviewAssessmentResults`	object	No	—	reviewAssessmentResults
`type`	string	No	—	The type for the learning module. Informational, AssessedContent and Assessment are deprecated

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "moduleId": {
      "type": "string",
      "description": "The ID of the learning module"
    },
    "assessmentForm": {
      "type": "object",
      "description": "assessmentForm"
    },
    "autoAssign": {
      "type": "object",
      "description": "Auto assign request"
    },
    "completionTimeInDays": {
      "type": "integer",
      "description": "The completion time of learning module in days"
    },
    "coverArt": {
      "type": "object",
      "description": "coverArt"
    },
    "description": {
      "type": "string",
      "description": "The description of learning module"
    },
    "enforceContentOrder": {
      "type": "boolean",
      "description": "If true, learning module content should be viewed one by one in order"
    },
    "excludedFromCatalog": {
      "type": "boolean",
      "description": "If true, learning module is excluded when retrieving modules for manual assignment"
    },
    "externalId": {
      "type": "string",
      "description": "The external ID of the learning module. Maximum length: 50 characters."
    },
    "informSteps": {
      "type": "array",
      "description": "The list of inform steps in a learning module"
    },
    "lengthInMinutes": {
      "type": "integer",
      "description": "The recommended time in minutes to complete the module"
    },
    "name": {
      "type": "string",
      "description": "The name of learning module"
    },
    "reviewAssessmentResults": {
      "type": "object",
      "description": "reviewAssessmentResults"
    },
    "type": {
      "type": "string",
      "description": "The type for the learning module. Informational, AssessedContent and Assessment are deprecated",
      "enum": [
        "Informational",
        "AssessedContent",
        "Assessment",
        "External",
        "Native"
      ]
    }
  },
  "required": [
    "PCID",
    "moduleId",
    "completionTimeInDays",
    "name"
  ]
}

genesys_coaching_put_learning_module_preview

Update a learning module preview Parameters:

Parameter	Type	Required	Default	Description
`moduleId`	string	Yes	—	The ID of the learning module
`assessment`	object	No	—	assessment
`assessmentForm`	object	No	—	assessmentForm
`currentStep`	object	No	—	Learning module preview update request current step
`state`	string	No	—	The assignment State
`steps`	any[]	No	—	The assignment Steps

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "moduleId": {
      "type": "string",
      "description": "The ID of the learning module"
    },
    "assessment": {
      "type": "object",
      "description": "assessment"
    },
    "assessmentForm": {
      "type": "object",
      "description": "assessmentForm"
    },
    "currentStep": {
      "type": "object",
      "description": "Learning module preview update request current step"
    },
    "state": {
      "type": "string",
      "description": "The assignment State",
      "enum": [
        "Assigned",
        "InProgress",
        "Completed",
        "Deleted",
        "NotCompleted",
        "InvalidSchedule"
      ]
    },
    "steps": {
      "type": "array",
      "description": "The assignment Steps"
    }
  },
  "required": [
    "PCID",
    "moduleId"
  ]
}

genesys_coaching_put_learning_module_rule

Update a learning module rule Parameters:

Parameter	Type	Required	Default	Description
`moduleId`	string	Yes	—	The ID of the learning module
`assign`	boolean	No	—	Whether to assign the module to users or not
`id`	string	No	—	The globally unique identifier for the object.
`isActive`	boolean	Yes	—	If true, rule is active
`parts`	any[]	Yes	—	The parts of a learning module rule
`selfUri`	string	No	—	The URI for this object

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "moduleId": {
      "type": "string",
      "description": "The ID of the learning module"
    },
    "assign": {
      "type": "boolean",
      "description": "Whether to assign the module to users or not"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "isActive": {
      "type": "boolean",
      "description": "If true, rule is active"
    },
    "parts": {
      "type": "array",
      "description": "The parts of a learning module rule"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    }
  },
  "required": [
    "PCID",
    "moduleId",
    "isActive",
    "parts"
  ]
}

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

​Tools

​genesys_coaching_delete_appointment

​genesys_coaching_delete_appointment_annotation

​genesys_coaching_delete_learning_assignment

​genesys_coaching_delete_learning_module

​genesys_coaching_get_appointment

​genesys_coaching_get_appointment_annotation

​genesys_coaching_get_appointment_annotations

​genesys_coaching_get_appointment_statuses

​genesys_coaching_get_appointments

​genesys_coaching_get_appointments_me

​genesys_coaching_get_learning_assignment

​genesys_coaching_get_learning_assignment_step

​genesys_coaching_get_learning_assignments

​genesys_coaching_get_learning_assignments_me

​genesys_coaching_get_learning_module

​genesys_coaching_get_learning_module_job

​genesys_coaching_get_learning_module_preview

​genesys_coaching_get_learning_module_rule

​genesys_coaching_get_learning_module_version

​genesys_coaching_get_learning_modules

​genesys_coaching_get_learning_modules_assignments

​genesys_coaching_get_learning_modules_coverart_cover_art_id

​genesys_coaching_get_learning_scheduleslots_job

​genesys_coaching_get_learning_scorm_scorm_id

​genesys_coaching_get_notification

​genesys_coaching_get_notifications

​genesys_coaching_get_scheduleslots_job

​genesys_coaching_patch_appointment

​genesys_coaching_patch_appointment_annotation

​genesys_coaching_patch_appointment_status

​genesys_coaching_patch_learning_assignment

​genesys_coaching_patch_learning_assignment_reschedule

​genesys_coaching_patch_learning_assignment_step

​genesys_coaching_patch_learning_module_user_assignments

​genesys_coaching_patch_notification

​genesys_coaching_post_appointment_annotations

​genesys_coaching_post_appointment_conversations

​genesys_coaching_post_appointments

​genesys_coaching_post_appointments_aggregates_query

​genesys_coaching_post_learning_assessments_scoring

​genesys_coaching_post_learning_assignment_reassign

​genesys_coaching_post_learning_assignment_reset

​genesys_coaching_post_learning_assignments

​genesys_coaching_post_learning_assignments_aggregates_query

​genesys_coaching_post_learning_module_jobs

​genesys_coaching_post_learning_module_publish

​genesys_coaching_post_learning_modules

​genesys_coaching_post_learning_rules_query

​genesys_coaching_post_learning_scheduleslots_jobs

​genesys_coaching_post_learning_scheduleslots_query

​genesys_coaching_post_learning_scorm

​genesys_coaching_post_scheduleslots_jobs

​genesys_coaching_post_scheduleslots_query

​genesys_coaching_put_learning_module

​genesys_coaching_put_learning_module_preview

​genesys_coaching_put_learning_module_rule

Tools

genesys_coaching_delete_appointment

genesys_coaching_delete_appointment_annotation

genesys_coaching_delete_learning_assignment

genesys_coaching_delete_learning_module

genesys_coaching_get_appointment

genesys_coaching_get_appointment_annotation

genesys_coaching_get_appointment_annotations

genesys_coaching_get_appointment_statuses

genesys_coaching_get_appointments

genesys_coaching_get_appointments_me

genesys_coaching_get_learning_assignment

genesys_coaching_get_learning_assignment_step

genesys_coaching_get_learning_assignments

genesys_coaching_get_learning_assignments_me

genesys_coaching_get_learning_module

genesys_coaching_get_learning_module_job

genesys_coaching_get_learning_module_preview

genesys_coaching_get_learning_module_rule

genesys_coaching_get_learning_module_version

genesys_coaching_get_learning_modules

genesys_coaching_get_learning_modules_assignments

genesys_coaching_get_learning_modules_coverart_cover_art_id

genesys_coaching_get_learning_scheduleslots_job

genesys_coaching_get_learning_scorm_scorm_id

genesys_coaching_get_notification

genesys_coaching_get_notifications

genesys_coaching_get_scheduleslots_job

genesys_coaching_patch_appointment

genesys_coaching_patch_appointment_annotation

genesys_coaching_patch_appointment_status

genesys_coaching_patch_learning_assignment

genesys_coaching_patch_learning_assignment_reschedule

genesys_coaching_patch_learning_assignment_step

genesys_coaching_patch_learning_module_user_assignments

genesys_coaching_patch_notification

genesys_coaching_post_appointment_annotations

genesys_coaching_post_appointment_conversations

genesys_coaching_post_appointments

genesys_coaching_post_appointments_aggregates_query

genesys_coaching_post_learning_assessments_scoring

genesys_coaching_post_learning_assignment_reassign

genesys_coaching_post_learning_assignment_reset

genesys_coaching_post_learning_assignments

genesys_coaching_post_learning_assignments_aggregates_query

genesys_coaching_post_learning_module_jobs

genesys_coaching_post_learning_module_publish

genesys_coaching_post_learning_modules

genesys_coaching_post_learning_rules_query

genesys_coaching_post_learning_scheduleslots_jobs

genesys_coaching_post_learning_scheduleslots_query

genesys_coaching_post_learning_scorm

genesys_coaching_post_scheduleslots_jobs

genesys_coaching_post_scheduleslots_query

genesys_coaching_put_learning_module

genesys_coaching_put_learning_module_preview

genesys_coaching_put_learning_module_rule