{
  "opencollection": "1.0.0",
  "info": {
    "name": "PureCloud Platform Agent Assistants Coaching API",
    "version": "v2"
  },
  "items": [
    {
      "info": {
        "name": "Coaching",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve an annotation.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/coaching/appointments/:appointmentId/annotations/:annotationId",
            "params": [
              {
                "name": "appointmentId",
                "value": "",
                "type": "path",
                "description": "The ID of the coaching appointment."
              },
              {
                "name": "annotationId",
                "value": "",
                "type": "path",
                "description": "The ID of the annotation."
              }
            ]
          },
          "docs": "You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations)."
        },
        {
          "info": {
            "name": "Update an existing annotation.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/coaching/appointments/:appointmentId/annotations/:annotationId",
            "params": [
              {
                "name": "appointmentId",
                "value": "",
                "type": "path",
                "description": "The ID of the coaching appointment."
              },
              {
                "name": "annotationId",
                "value": "",
                "type": "path",
                "description": "The ID of the annotation."
              }
            ]
          },
          "docs": "You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment"
        },
        {
          "info": {
            "name": "Delete an existing annotation",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/coaching/appointments/:appointmentId/annotations/:annotationId",
            "params": [
              {
                "name": "appointmentId",
                "value": "",
                "type": "path",
                "description": "The ID of the coaching appointment."
              },
              {
                "name": "annotationId",
                "value": "",
                "type": "path",
                "description": "The ID of the annotation."
              }
            ]
          },
          "docs": "You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment"
        },
        {
          "info": {
            "name": "Get a list of annotations.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/coaching/appointments/:appointmentId/annotations",
            "params": [
              {
                "name": "appointmentId",
                "value": "",
                "type": "path",
                "description": "The ID of the coaching appointment."
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Page size"
              }
            ]
          },
          "docs": "You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations)."
        },
        {
          "info": {
            "name": "Create a new annotation.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/coaching/appointments/:appointmentId/annotations",
            "params": [
              {
                "name": "appointmentId",
                "value": "",
                "type": "path",
                "description": "The ID of the coaching appointment."
              }
            ]
          },
          "docs": "You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can create private annotations)."
        },
        {
          "info": {
            "name": "Retrieve an appointment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/coaching/appointments/:appointmentId",
            "params": [
              {
                "name": "appointmentId",
                "value": "",
                "type": "path",
                "description": "The ID of the coaching appointment."
              }
            ]
          },
          "docs": "Permission not required if you are the attendee, creator or facilitator of the appointment"
        },
        {
          "info": {
            "name": "Update an existing appointment",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/coaching/appointments/:appointmentId",
            "params": [
              {
                "name": "appointmentId",
                "value": "",
                "type": "path",
                "description": "The ID of the coaching appointment."
              }
            ]
          },
          "docs": "Permission not required if you are the creator or facilitator of the appointment"
        },
        {
          "info": {
            "name": "Delete an existing appointment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/coaching/appointments/:appointmentId",
            "params": [
              {
                "name": "appointmentId",
                "value": "",
                "type": "path",
                "description": "The ID of the coaching appointment."
              }
            ]
          },
          "docs": "Permission not required if you are the creator of the appointment"
        },
        {
          "info": {
            "name": "Add a conversation to an appointment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/coaching/appointments/:appointmentId/conversations",
            "params": [
              {
                "name": "appointmentId",
                "value": "",
                "type": "path",
                "description": "The ID of the coaching appointment."
              }
            ]
          },
          "docs": "Permission not required if you are the creator or facilitator of the appointment"
        },
        {
          "info": {
            "name": "Update the status of a coaching appointment",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/coaching/appointments/:appointmentId/status",
            "params": [
              {
                "name": "appointmentId",
                "value": "",
                "type": "path",
                "description": "The ID of the coaching appointment."
              }
            ]
          },
          "docs": "Permission not required if you are an attendee, creator or facilitator of the appointment"
        },
        {
          "info": {
            "name": "Get the list of status changes for a coaching appointment.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/coaching/appointments/:appointmentId/statuses",
            "params": [
              {
                "name": "appointmentId",
                "value": "",
                "type": "path",
                "description": "The ID of the coaching appointment."
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Page size"
              }
            ]
          },
          "docs": "Permission not required if you are an attendee, creator or facilitator of the appointment"
        },
        {
          "info": {
            "name": "Retrieve aggregated appointment data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/coaching/appointments/aggregates/query"
          },
          "docs": "Retrieve aggregated appointment data"
        },
        {
          "info": {
            "name": "Get appointments for users and optional date range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/coaching/appointments",
            "params": [
              {
                "name": "userIds",
                "value": "",
                "type": "query",
                "description": "The user IDs for which to retrieve appointments"
              },
              {
                "name": "interval",
                "value": "",
                "type": "query",
                "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"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Page size"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "Appointment Statuses to filter by"
              },
              {
                "name": "facilitatorIds",
                "value": "",
                "type": "query",
                "description": "The facilitator IDs for which to retrieve appointments"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort (by due date) either Asc or Desc"
              },
              {
                "name": "relationships",
                "value": "",
                "type": "query",
                "description": "Relationships to filter by"
              },
              {
                "name": "completionInterval",
                "value": "",
                "type": "query",
                "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"
              },
              {
                "name": "overdue",
                "value": "",
                "type": "query",
                "description": "Overdue status to filter by"
              },
              {
                "name": "intervalCondition",
                "value": "",
                "type": "query",
                "description": "Filter condition for interval"
              }
            ]
          },
          "docs": "Get appointments for users and optional date range"
        },
        {
          "info": {
            "name": "Create a new appointment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/coaching/appointments"
          },
          "docs": "Create a new appointment"
        },
        {
          "info": {
            "name": "Get an existing notification",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/coaching/notifications/:notificationId",
            "params": [
              {
                "name": "notificationId",
                "value": "",
                "type": "path",
                "description": "The ID of the notification."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Indicates a field in the response which should be expanded."
              }
            ]
          },
          "docs": "Permission not required if you are the owner of the notification."
        },
        {
          "info": {
            "name": "Update an existing notification.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/coaching/notifications/:notificationId",
            "params": [
              {
                "name": "notificationId",
                "value": "",
                "type": "path",
                "description": "The ID of the notification."
              }
            ]
          },
          "docs": "Can only update your own notifications."
        },
        {
          "info": {
            "name": "Retrieve the list of your notifications.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/coaching/notifications",
            "params": [
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Page size"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Indicates a field in the response which should be expanded."
              }
            ]
          },
          "docs": "Retrieve the list of your notifications."
        },
        {
          "info": {
            "name": "Get list of possible slots where a coaching appointment can be scheduled.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/coaching/scheduleslots/query"
          },
          "docs": "Get list of possible slots where a coaching appointment can be scheduled."
        },
        {
          "info": {
            "name": "Start job to retrieve the slots where a coaching appointment can be scheduled.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/coaching/scheduleslots/jobs"
          },
          "docs": "Start job to retrieve the slots where a coaching appointment can be scheduled."
        },
        {
          "info": {
            "name": "Retrieve the status of the job for the slots where a coaching appointment can be scheduled.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/coaching/scheduleslots/jobs/:jobId",
            "params": [
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "The ID of job"
              }
            ]
          },
          "docs": "Retrieve the status of the job for the slots where a coaching appointment can be scheduled."
        },
        {
          "info": {
            "name": "Get my appointments for a given date range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/coaching/appointments/me",
            "params": [
              {
                "name": "interval",
                "value": "",
                "type": "query",
                "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"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Page number"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Page size"
              },
              {
                "name": "statuses",
                "value": "",
                "type": "query",
                "description": "Appointment Statuses to filter by"
              },
              {
                "name": "facilitatorIds",
                "value": "",
                "type": "query",
                "description": "The facilitator IDs for which to retrieve appointments"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort (by due date) either Asc or Desc"
              },
              {
                "name": "relationships",
                "value": "",
                "type": "query",
                "description": "Relationships to filter by"
              },
              {
                "name": "completionInterval",
                "value": "",
                "type": "query",
                "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"
              },
              {
                "name": "overdue",
                "value": "",
                "type": "query",
                "description": "Overdue status to filter by"
              },
              {
                "name": "intervalCondition",
                "value": "",
                "type": "query",
                "description": "Filter condition for interval"
              }
            ]
          },
          "docs": "Get my appointments for a given date range"
        }
      ]
    }
  ],
  "bundled": true
}