swagger: '2.0' info: description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more. version: v2 title: PureCloud Platform Agent Assistants Response Management API termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/ contact: name: PureCloud Developer Evangelists url: https://developer.genesys.cloud/ email: DeveloperEvangelists@genesys.com license: name: UNLICENSED url: https://help.genesys.cloud/articles/terms-and-conditions/ host: api.mypurecloud.com schemes: - https consumes: - application/json produces: - application/json tags: - name: Response Management description: Responses, library, Response Assets, query externalDocs: description: Response Management Documentation url: https://developer.genesys.cloud/organization/responsemanagement-apis paths: /api/v2/responsemanagement/libraries/bulk: post: tags: - Response Management summary: Get response libraries. description: '' operationId: postResponsemanagementLibrariesBulk produces: - application/json parameters: - in: body name: body description: LibraryIDs (max allowed 50) required: true schema: $ref: '#/definitions/LibraryBatchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/LibraryEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: rms.exceeds.maximum.library.batch.size: Exceeds maximum batch size limit. rms.missing.field: Missing Field. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management - response-management:readonly x-inin-requires-permissions: type: ANY permissions: - responses:library:view x-purecloud-method-name: postResponsemanagementLibrariesBulk /api/v2/responsemanagement/libraries/query: post: tags: - Response Management summary: Query libraries using criteria. Users can set DivisionId parameter as '*' to fetch libraries that aren't associated with any divisions. description: '' operationId: postResponsemanagementLibrariesQuery produces: - application/json parameters: - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - in: body name: body description: Query criteria required: true schema: $ref: '#/definitions/QueryCriteriaQuery' responses: '200': description: successful operation schema: $ref: '#/definitions/LibraryEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management - response-management:readonly x-inin-requires-permissions: type: ANY permissions: - responses:library:view x-purecloud-method-name: postResponsemanagementLibrariesQuery /api/v2/responsemanagement/libraries: get: tags: - Response Management summary: Gets a list of existing response libraries. description: '' operationId: getResponsemanagementLibraries produces: - application/json parameters: - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: messagingTemplateFilter in: query description: Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel required: false type: string enum: - whatsapp - name: libraryPrefix in: query description: Returns a list of libraries that contain the prefix provided required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/LibraryEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management - response-management:readonly x-inin-requires-permissions: type: ANY permissions: - responses:library:view x-purecloud-method-name: getResponsemanagementLibraries post: tags: - Response Management summary: Create a response library. description: '' operationId: postResponsemanagementLibraries produces: - application/json parameters: - in: body name: body description: Library required: true schema: $ref: '#/definitions/Library' responses: '200': description: successful operation schema: $ref: '#/definitions/Library' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management x-inin-requires-permissions: type: ANY permissions: - responses:library:add x-purecloud-method-name: postResponsemanagementLibraries /api/v2/responsemanagement/libraries/{libraryId}: get: tags: - Response Management summary: Get details about an existing response library. description: '' operationId: getResponsemanagementLibrary produces: - application/json parameters: - name: libraryId in: path description: Library ID required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Library' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: rms.library.not.found: The response library could not be found not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management - response-management:readonly x-inin-requires-permissions: type: ANY permissions: - responses:library:view x-purecloud-method-name: getResponsemanagementLibrary put: tags: - Response Management summary: Update an existing response library. description: 'Fields that can be updated: name. The most recent version is required for updates.' operationId: putResponsemanagementLibrary produces: - application/json parameters: - name: libraryId in: path description: Library ID required: true type: string - in: body name: body description: Library required: true schema: $ref: '#/definitions/Library' responses: '200': description: successful operation schema: $ref: '#/definitions/Library' '409': description: Resource conflict - Unexpected version was provided x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management x-inin-requires-permissions: type: ALL permissions: - responses:library:edit x-purecloud-method-name: putResponsemanagementLibrary delete: tags: - Response Management summary: Delete an existing response library. description: This will remove any responses associated with the library. operationId: deleteResponsemanagementLibrary produces: - application/json parameters: - name: libraryId in: path description: Library ID required: true type: string responses: default: description: successful operation '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management x-inin-requires-permissions: type: ANY permissions: - responses:library:delete x-purecloud-method-name: deleteResponsemanagementLibrary /api/v2/responsemanagement/responses/query: post: tags: - Response Management summary: Query responses description: '' operationId: postResponsemanagementResponsesQuery produces: - application/json parameters: - in: body name: body description: Response required: true schema: $ref: '#/definitions/ResponseQueryRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ResponseQueryResults' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' rms.field.unexpected.value: One or more fields in the payload contained unexpected values. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: rms.internal.server.error: The request failed due to an internal server error. internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management - response-management:readonly x-inin-requires-permissions: type: ANY permissions: - responses:response:view x-purecloud-method-name: postResponsemanagementResponsesQuery /api/v2/responsemanagement/responses/{responseId}: get: tags: - Response Management summary: Get details about an existing response. description: '' operationId: getResponsemanagementResponse produces: - application/json parameters: - name: responseId in: path description: Response ID required: true type: string - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - substitutionsSchema responses: '200': description: successful operation schema: $ref: '#/definitions/Response' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: The user do not have permission to any of the divisionIds of the libraries to which this response belongs to '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. rms.response.not.found: The response could not be found '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management - response-management:readonly x-inin-requires-permissions: type: ANY permissions: - responses:response:view x-purecloud-method-name: getResponsemanagementResponse put: tags: - Response Management summary: Update an existing response. description: 'Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.' operationId: putResponsemanagementResponse produces: - application/json parameters: - name: responseId in: path description: Response ID required: true type: string - in: body name: body description: Response required: true schema: $ref: '#/definitions/Response' - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - substitutionsSchema responses: '200': description: successful operation schema: $ref: '#/definitions/Response' '409': description: Resource conflict - Unexpected version was provided x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management x-inin-requires-permissions: type: ANY permissions: - responses:response:edit x-purecloud-method-name: putResponsemanagementResponse delete: tags: - Response Management summary: Delete an existing response. description: This will remove the response from any libraries associated with it. operationId: deleteResponsemanagementResponse produces: - application/json parameters: - name: responseId in: path description: Response ID required: true type: string responses: default: description: successful operation '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management x-inin-requires-permissions: type: ANY permissions: - responses:response:delete x-purecloud-method-name: deleteResponsemanagementResponse /api/v2/responsemanagement/responses: get: tags: - Response Management summary: Gets a list of existing responses. description: '' operationId: getResponsemanagementResponses produces: - application/json parameters: - name: libraryId in: query description: Library ID required: true type: string - name: pageNumber in: query description: Page number required: false type: integer default: 1 format: int32 - name: pageSize in: query description: Page size required: false type: integer default: 25 format: int32 - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - substitutionsSchema responses: '200': description: successful operation schema: $ref: '#/definitions/ResponseEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management - response-management:readonly x-inin-requires-permissions: type: ANY permissions: - responses:response:view x-purecloud-method-name: getResponsemanagementResponses post: tags: - Response Management summary: Create a response. description: '' operationId: postResponsemanagementResponses produces: - application/json parameters: - in: body name: body description: Response required: true schema: $ref: '#/definitions/Response' - name: expand in: query description: Expand instructions for the return value. required: false type: string enum: - substitutionsSchema responses: '200': description: successful operation schema: $ref: '#/definitions/Response' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: rms.not.a.user: Unable to find user rms.exceeds.asset.maximum.file.size: Response asset file size exceeds limit. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] rms.exceeds.maximum.mms.response.assets: Too many response assets constraint.validation: '%s' rms.field.exceeds.max.length: Field exceeds max length invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. '412': description: Precondition Failed schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: rms.precondition: Response precondition not met. security: - PureCloud OAuth: - response-management x-inin-requires-permissions: type: ANY permissions: - responses:response:add x-purecloud-method-name: postResponsemanagementResponses /api/v2/responsemanagement/responseassets/{responseAssetId}: get: tags: - Response Management summary: Get response asset information description: '' operationId: getResponsemanagementResponseasset produces: - application/json parameters: - name: responseAssetId in: path description: Asset Id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ResponseAsset' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management - response-management:readonly x-inin-requires-permissions: type: ANY permissions: - responseAssets:asset:view x-purecloud-method-name: getResponsemanagementResponseasset put: tags: - Response Management summary: Update response asset description: '' operationId: putResponsemanagementResponseasset produces: - application/json parameters: - name: responseAssetId in: path description: Asset Id required: true type: string - in: body name: body description: request required: true schema: $ref: '#/definitions/ResponseAssetRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ResponseAsset' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management x-inin-requires-permissions: type: ALL permissions: - responseAssets:asset:edit x-purecloud-method-name: putResponsemanagementResponseasset delete: tags: - Response Management summary: Delete response asset description: '' operationId: deleteResponsemanagementResponseasset produces: - application/json parameters: - name: responseAssetId in: path description: Asset Id required: true type: string responses: '204': description: Response asset is deleted '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management x-inin-requires-permissions: type: ANY permissions: - responseAssets:asset:delete x-purecloud-method-name: deleteResponsemanagementResponseasset /api/v2/responsemanagement/responseassets/status/{statusId}: get: tags: - Response Management summary: Get response asset upload status description: '' operationId: getResponsemanagementResponseassetsStatusStatusId produces: - application/json parameters: - name: statusId in: path description: Status Id required: true type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ResponseAssetStatus' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management - response-management:readonly x-inin-requires-permissions: type: ANY permissions: - responseAssets:asset:view x-purecloud-method-name: getResponsemanagementResponseassetsStatusStatusId /api/v2/responsemanagement/responseassets/bulk: post: tags: - Response Management summary: Get response assets. description: '' operationId: postResponsemanagementResponseassetsBulk produces: - application/json parameters: - in: body name: body description: Asset IDs (max allowed 50) required: true schema: $ref: '#/definitions/ResponseAssetBulkRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ResponseAssetEntityListing' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: rms.missing.field: Missing Field. bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. rms.exceeds.maximum.asset.bulk.size: Exceeds maximum bulk size limit (50). invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management - response-management:readonly x-inin-requires-permissions: type: ANY permissions: - responseAssets:asset:view x-purecloud-method-name: postResponsemanagementResponseassetsBulk /api/v2/responsemanagement/responseassets/uploads: post: tags: - Response Management summary: Creates pre-signed url for uploading response asset description: '' operationId: postResponsemanagementResponseassetsUploads produces: - application/json parameters: - in: body name: body description: request required: true schema: $ref: '#/definitions/CreateResponseAssetRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/CreateResponseAssetResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: invalid.content.md5: Invalid Content bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. image.limit.exceeded: Organization has reached the maximum allowed number of images. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management x-inin-requires-permissions: type: ANY permissions: - responseAssets:asset:add x-purecloud-method-name: postResponsemanagementResponseassetsUploads /api/v2/responsemanagement/responseassets/search: post: tags: - Response Management summary: Search response assets description: '' operationId: postResponsemanagementResponseassetsSearch produces: - application/json parameters: - name: expand in: query description: Which fields, if any, to expand required: false type: array items: type: string enum: - user - division collectionFormat: multi - in: body name: body description: request required: true schema: $ref: '#/definitions/ResponseAssetSearchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ResponseAssetSearchResults' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - response-management - response-management:readonly x-inin-requires-permissions: type: ALL permissions: - responseAssets:asset:view x-purecloud-method-name: postResponsemanagementResponseassetsSearch definitions: Team: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The team name division: description: The division to which this entity belongs. $ref: '#/definitions/WritableDivision' description: type: string description: Team information. dateCreated: type: string format: date-time description: 'Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateModified: type: string format: date-time description: 'Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true memberCount: type: integer format: int64 description: Number of members in a team readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true WorkPlanBidRanks: type: object properties: id: type: string description: The globally unique identifier for the user. workPlanBiddingPerformance: type: integer format: int32 description: Work plan bidding agent performance ranking. The range of values is between 0 and 9999. biddingTieBreaker: type: string description: Custom agent ranking metric that some customers can use. selfUri: type: string format: uri description: The URI for this object readOnly: true AddressableEntityRef: type: object properties: id: type: string selfUri: type: string format: uri JsonSchemaDocument: type: object properties: id: type: string $schema: type: string title: type: string description: type: string type: type: string required: type: array items: type: string properties: type: object additionalProperties: type: object additionalProperties: type: object description: A JSON Schema document. Response: type: object required: - libraries properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string version: type: integer format: int32 description: Version number required for updates. libraries: type: array description: One or more libraries response is associated with. items: $ref: '#/definitions/DomainEntityRef' texts: type: array description: 'One or more texts associated with the response. Required for responseTypes: Standard, Footer, MessagingTemplate and CampaignEmailTemplate' items: $ref: '#/definitions/ResponseText' createdBy: description: User that created the response readOnly: true $ref: '#/definitions/User' dateCreated: type: string format: date-time description: 'The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true interactionType: type: string description: The interaction type for this response. enum: - chat - email - twitter substitutions: type: array description: Details about any text substitutions used in the texts for this response. items: $ref: '#/definitions/ResponseSubstitution' substitutionsSchema: description: Metadata about the text substitutions in json schema format. $ref: '#/definitions/JsonSchemaDocument' responseType: type: string description: The response type represented by the response. enum: - MessagingTemplate - CampaignSmsTemplate - CampaignEmailTemplate - Footer - Form - AppleInvitation messagingTemplate: description: An optional messaging template definition for responseType.MessagingTemplate. $ref: '#/definitions/MessagingTemplate' assets: type: array description: Assets used in the response items: $ref: '#/definitions/RmsAssetAddressableRef' footer: description: Footer template definition for responseType.Footer. $ref: '#/definitions/FooterTemplate' appleInvitation: description: Apple Messages for Business invitation template definition for responseType.AppleInvitation. $ref: '#/definitions/AppleInvitation' selfUri: type: string format: uri description: The URI for this object readOnly: true description: Contains information about a response. ResourcePermissionPolicy: type: object properties: id: type: string domain: type: string entityName: type: string policyName: type: string policyDescription: type: string actionSetKey: type: string allowConditions: type: boolean resourceConditionNode: $ref: '#/definitions/ResourceConditionNode' namedResources: type: array items: type: string resourceCondition: type: string actionSet: type: array uniqueItems: true items: type: string ResponseAssetRequest: type: object required: - name properties: name: type: string description: 'Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \{^}%`]">[~<#|' divisionId: type: string description: Division to associate to this asset. Can only be used with this division. WritableDivision: type: object properties: id: type: string description: The globally unique identifier for the object. name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true UserStations: type: object properties: associatedStation: description: Current associated station for this user. readOnly: true $ref: '#/definitions/UserStation' effectiveStation: description: The station where the user can be reached based on their default and associated station. readOnly: true $ref: '#/definitions/UserStation' defaultStation: description: Default station to be used if not associated with a station. readOnly: true $ref: '#/definitions/UserStation' lastAssociatedStation: description: Last associated station for this user. readOnly: true $ref: '#/definitions/UserStation' CreateResponseAssetResponse: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true url: type: string description: Pre-signed URL to PUT the file to readOnly: true headers: type: object description: Required headers when uploading a file through PUT request to the URL readOnly: true additionalProperties: type: string OAuthLastTokenIssued: type: object properties: dateIssued: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' FooterTemplate: type: object properties: type: type: string description: Specifies the type represented by Footer. enum: - Signature applicableResources: type: array description: Specifies the canned response template where the footer can be used. items: type: string enum: - Campaign description: The Footer template identifies the Footer type and its footerUsage MediaSummary: type: object properties: contactCenter: $ref: '#/definitions/MediaSummaryDetail' enterprise: $ref: '#/definitions/MediaSummaryDetail' LocationAddressVerificationDetails: type: object properties: status: type: string description: Status of address verification process enum: - Pending - InProgress - Retry - Complete - Failed dateFinished: type: string format: date-time description: 'Finished time of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' dateStarted: type: string format: date-time description: 'Time started of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' service: type: string example: smartystreets-us description: Third party service used for address verification ResponseText: type: object required: - content properties: content: type: string description: Response text content. contentType: type: string description: Response text content type. enum: - text/plain - text/html type: type: string description: Response text type. enum: - body - subject description: Contains information about the text associated with a response. Geolocation: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string type: type: string description: A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc. primary: type: boolean description: A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH latitude: type: number format: double longitude: type: number format: double country: type: string region: type: string city: type: string locations: type: array items: $ref: '#/definitions/LocationDefinition' selfUri: type: string format: uri description: The URI for this object readOnly: true UserRoutingLanguage: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string proficiency: type: number format: double description: A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings. state: type: string description: Activate or deactivate this routing language. enum: - active - inactive - deleted languageUri: type: string format: uri description: URI to the organization language used by this user language. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true description: Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id. ResponseQueryRequest: type: object properties: queryPhrase: type: string description: Query phrase to search response text and name. If not set will match all. pageSize: type: integer format: int32 description: 'The maximum number of hits to return. Default: 25, Maximum: 500.' pageNumber: type: integer format: int32 description: Page Number filters: type: array description: Filter the query results. items: $ref: '#/definitions/ResponseFilter' description: Used to query for responses ResponseAssetSearchResults: type: object properties: total: type: integer format: int64 description: The total number of results found pageCount: type: integer format: int32 description: The total number of pages pageSize: type: integer format: int32 description: The current page size pageNumber: type: integer format: int32 description: The current page number results: type: array description: Search results items: $ref: '#/definitions/ResponseAsset' LibraryBatchRequest: type: object required: - libraryIds properties: libraryIds: type: array description: List of Library IDs items: type: string ResponseAssetFilter: type: object properties: endValue: type: string description: The end value of the range. This field is used for range search types. Accepts numbers and date in ISO8601 format values: type: array description: A list of values for the search to match against items: type: string startValue: type: string description: The start value of the range. This field is used for range search types. Accepts numbers and date in ISO8601 format fields: type: array description: 'Field name to search against. Allowed Values: divisionId, name, contentLength, contentType, dateCreated' items: type: string value: type: string description: A value for the search to match against type: type: string description: How to apply this search criteria against other criteria. Filter type supported for each field:- name:[STARTS_WITH, TERM], divisionId:[TERM, TERMS], contentLength:[RANGE, GREATER_THAN_EQUAL_TO, LESS_THAN_EQUAL_TO], contentType:[STARTS_WITH, TERM] dateCreated:[DATE_RANGE] enum: - TERM - TERMS - STARTS_WITH - RANGE - GREATER_THAN_EQUAL_TO - LESS_THAN_EQUAL_TO - DATE_RANGE ResponseAssetStatus: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true status: type: string description: Upload status of the asset readOnly: true enum: - InProgress - Uploaded - Failed errorCode: type: string description: Error code. Used for localization readOnly: true errorMessage: type: string description: 'Error message that explains upload failure status ' readOnly: true MessageFooter: type: object properties: type: type: string description: Defines the content type of the footer in message enum: - Text content: type: string description: Content associated with the footer in the message User: type: object required: - version properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string division: description: The division to which this entity belongs. $ref: '#/definitions/Division' chat: $ref: '#/definitions/Chat' department: type: string email: type: string primaryContactInfo: type: array description: Auto populated from addresses. readOnly: true items: $ref: '#/definitions/Contact' addresses: type: array description: Email addresses and phone numbers for this user items: $ref: '#/definitions/Contact' state: type: string description: The current state for this user. readOnly: true enum: - active - inactive - deleted title: type: string username: type: string manager: $ref: '#/definitions/User' images: type: array items: $ref: '#/definitions/Image' version: type: integer format: int32 description: Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH. certifications: type: array items: type: string biography: $ref: '#/definitions/Biography' employerInfo: $ref: '#/definitions/EmployerInfo' preferredName: type: string description: Preferred full name of the agent routingStatus: description: ACD routing status readOnly: true $ref: '#/definitions/RoutingStatus' presence: description: Active presence readOnly: true $ref: '#/definitions/UserPresence' integrationPresence: description: Integration presence readOnly: true $ref: '#/definitions/UserPresence' conversationSummary: description: Summary of conversion statistics for conversation types. readOnly: true $ref: '#/definitions/UserConversationSummary' outOfOffice: description: Determine if out of office is enabled readOnly: true $ref: '#/definitions/OutOfOffice' geolocation: description: Current geolocation position readOnly: true $ref: '#/definitions/Geolocation' station: description: Effective, default, and last station information readOnly: true $ref: '#/definitions/UserStations' authorization: description: Roles and permissions assigned to the user readOnly: true $ref: '#/definitions/UserAuthorization' profileSkills: type: array description: Profile skills possessed by the user readOnly: true items: type: string locations: type: array description: The user placement at each site location. readOnly: true items: $ref: '#/definitions/Location' groups: type: array description: The groups the user is a member of readOnly: true items: $ref: '#/definitions/Group' team: description: The team the user is a member of readOnly: true $ref: '#/definitions/Team' workPlanBidRanks: description: The WFM work plan bid rank settings for the user readOnly: true $ref: '#/definitions/WorkPlanBidRanks' skills: type: array description: Routing (ACD) skills possessed by the user readOnly: true items: $ref: '#/definitions/UserRoutingSkill' languages: type: array description: Routing (ACD) languages possessed by the user readOnly: true items: $ref: '#/definitions/UserRoutingLanguage' acdAutoAnswer: type: boolean description: acd auto answer languagePreference: type: string description: preferred language by the user readOnly: true lastTokenIssued: $ref: '#/definitions/OAuthLastTokenIssued' dateLastLogin: type: string format: date-time description: 'The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true dateWelcomeSent: type: string format: date-time description: 'The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true MediaSummaryDetail: type: object properties: active: type: integer format: int32 acw: type: integer format: int32 Biography: type: object properties: biography: type: string description: Personal detailed description interests: type: array items: type: string hobbies: type: array items: type: string spouse: type: string education: type: array description: User education details items: $ref: '#/definitions/Education' CarouselCard: type: object required: - buttons - header properties: header: description: Header for whatsApp carousel card $ref: '#/definitions/MessageHeader' buttons: type: array description: List of buttons to be included in the whatsApp carousel messages template items: $ref: '#/definitions/Button' cardBodyText: description: Optional card body text to be included in the whatsApp carousel messages template $ref: '#/definitions/CardBodyText' ResponseAsset: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string division: description: The division to which this entity belongs. $ref: '#/definitions/Division' contentLength: type: integer format: int64 description: response asset size in bytes contentLocation: type: string description: response asset location. contentType: type: string description: MIME type of response asset dateCreated: type: string format: date-time description: 'Created date of the response asset. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' createdBy: description: User who created the response asset $ref: '#/definitions/DomainEntityRef' dateModified: type: string format: date-time description: 'Last modified date of the response asset. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' modifiedBy: description: User who last modified the response asset $ref: '#/definitions/DomainEntityRef' responses: type: array description: Canned responses actively using this asset items: $ref: '#/definitions/DomainEntityRef' selfUri: type: string format: uri description: The URI for this object readOnly: true StatusInfo: type: object properties: code: type: string description: Status code readOnly: true message: type: string description: Status Message readOnly: true ResourceConditionNode: type: object properties: variableName: type: string conjunction: type: string enum: - AND - OR operator: type: string enum: - EQ - IN - GE - GT - LE - LT operands: type: array items: $ref: '#/definitions/ResourceConditionValue' terms: type: array items: $ref: '#/definitions/ResourceConditionNode' MessagingTemplate: type: object properties: whatsApp: description: Defines a messaging template for a WhatsApp messaging channel $ref: '#/definitions/WhatsAppDefinition' description: The messaging template identifies a structured message templates supported by a messaging channel. ResponseFilter: type: object required: - name - operator - values properties: name: type: string description: Field to filter on. Allowed values are 'name', 'libraryId', 'text.contentType', 'messagingTemplate' and 'responseType' operator: type: string description: 'Filter operation: IN, EQUALS, NOTEQUALS.' enum: - IN - EQUALS - NOTEQUALS - BEGINS_WITH - ENDS_WITH - CONTAINS values: type: array description: Values to filter on. If name is 'responseType' then allowed values are 'CampaignSmsTemplate', 'CampaignEmailTemplate', 'Footer' and 'Signature' items: type: string description: Used to filter response queries DomainEntityRef: type: object properties: id: type: string name: type: string selfUri: type: string format: uri QueryCriteriaItem: type: object required: - key - operator properties: key: type: string description: The key to filter on enum: - Name - DivisionId - Id - CreatedBy operator: type: string description: The operator for comparison. For DivisionId, only EQUALS and NOTEQUALS operators are supported. enum: - IN - EQUALS - NOTEQUALS - BEGINS_WITH - ENDS_WITH - CONTAINS value: type: string description: The target value to match description: A singular item used to query libraries ResponseEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/Response' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 CardBodyText: type: object required: - content - contentType properties: content: type: string description: Body content for carousel card. contentType: type: string description: 'Body content type for carousel card. Allowed value: text/plain' enum: - text/plain Button: type: object properties: type: type: string description: Type of button to include in whatsApp template enum: - QuickReply - PhoneNumber - Url content: type: string description: Content of the button. Use for 'Url' or 'PhoneNumber' button type contentText: type: string description: The text label that will be displayed on the button payload: type: string description: A payload to uniquely identify a quickReply button in carousel DomainRole: type: object properties: id: type: string description: The ID of the role name: type: string description: The name of the role UserRoutingSkill: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string proficiency: type: number format: double description: A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When "Best available skills" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings. state: type: string description: Activate or deactivate this routing skill. enum: - active - inactive - deleted skillUri: type: string format: uri description: URI to the organization skill used by this user skill. readOnly: true selfUri: type: string format: uri description: The URI for this object readOnly: true description: Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id. PresenceDefinition: type: object properties: id: type: string description: description systemPresence: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true AppleInvitation: type: object required: - businessName - locale - templateType - transcriptMessage properties: businessName: type: string description: The business name displayed in the invitation transcriptMessage: type: string description: The transcript message displayed in the invitation templateType: type: string description: The template type for the invitation enum: - WithImage - WithoutImage locale: type: string description: The locale for the invitation description: Apple Messages for Business invitation template configuration Detail: type: object properties: errorCode: type: string fieldName: type: string entityId: type: string entityName: type: string UserAuthorization: type: object properties: roles: type: array items: $ref: '#/definitions/DomainRole' unusedRoles: type: array description: A collection of the roles the user is not using readOnly: true items: $ref: '#/definitions/DomainRole' permissions: type: array description: A collection of the permissions granted by all assigned roles readOnly: true items: type: string permissionPolicies: type: array description: The policies configured for assigned permissions. readOnly: true items: $ref: '#/definitions/ResourcePermissionPolicy' RmsAssetAddressableRef: type: object properties: id: type: string selfUri: type: string format: uri assetUsage: type: string description: Usage of the asset. Null for inline images, 'FileAttachments' for file attachments enum: - FileAttachments contentLocation: type: string description: Content location URL for the asset OutOfOffice: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string user: $ref: '#/definitions/User' startDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' endDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' active: type: boolean indefinite: type: boolean selfUri: type: string format: uri description: The URI for this object readOnly: true UserPresence: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string source: type: string description: Deprecated - The sourceID field should be used as a replacement. sourceId: type: string description: Represents the ID of a registered source primary: type: boolean description: A boolean used to tell whether or not to set this presence source as the primary on a PATCH presenceDefinition: $ref: '#/definitions/PresenceDefinition' futurePresenceDefinition: description: The definition of the user's desired future presence readOnly: true $ref: '#/definitions/PresenceDefinition' message: type: string modifiedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' selfUri: type: string format: uri description: The URI for this object readOnly: true LocationEmergencyNumber: type: object properties: e164: type: string number: type: string type: type: string description: The type of emergency number. enum: - default - elin EmployerInfo: type: object properties: officialName: type: string employeeId: type: string employeeType: type: string dateHire: type: string ResponseSubstitution: type: object required: - id properties: id: type: string description: Response substitution identifier. description: type: string description: Response substitution description. defaultValue: type: string description: Response substitution default value. description: Contains information about the substitutions associated with a response. RoutingStatus: type: object properties: userId: type: string description: The userId of the agent status: type: string description: Indicates the Routing State of the agent. A value of OFF_QUEUE will be returned if the specified user does not exist. enum: - OFF_QUEUE - IDLE - INTERACTING - NOT_RESPONDING - COMMUNICATING startTime: type: string format: date-time description: 'The timestamp when the agent went into this state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' LibraryEntityListing: type: object properties: entities: type: array items: $ref: '#/definitions/Library' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri pageCount: type: integer format: int32 Carousel: type: object required: - cards properties: cards: type: array description: List of cards in a carousels template. items: $ref: '#/definitions/CarouselCard' description: A WhatsApp Carousel messaging template definition ResourceConditionValue: type: object properties: type: type: string enum: - SCALAR - VARIABLE - USER - QUEUE - TEAM value: type: string QueryCriteriaGroup: type: object properties: and: type: array description: Items that will be AND'd together items: $ref: '#/definitions/QueryCriteriaItem' or: type: array description: Items that will be OR'd together items: $ref: '#/definitions/QueryCriteriaItem' not: type: array description: Items that must all be false items: $ref: '#/definitions/QueryCriteriaItem' criteria: description: A single item $ref: '#/definitions/QueryCriteriaItem' description: A group of logical items for library queries ResponseEntityList: type: object properties: entities: type: array items: $ref: '#/definitions/Response' pageSize: type: integer format: int32 pageNumber: type: integer format: int32 total: type: integer format: int64 pageCount: type: integer format: int32 description: Total number of pages firstUri: type: string format: uri nextUri: type: string format: uri previousUri: type: string format: uri lastUri: type: string format: uri selfUri: type: string format: uri description: Query result list Limit: type: object properties: key: type: string namespace: type: string enum: - web.deployments - web.messaging - agent.assistant - agentic.virtual.agents - analytics.agents - analytics.alerting - analytics.data.extraction - analytics - analytics.realtime - analytics.reporting.settings - anomaly.detection - architect - audiohook - audiohook.monitor - audit - auth.api - authorization - automation.testing - bots - bots.voice - business.rules - callback - case.management - cobrowse - content.management - conversation - copilot - dataactions - datatables - directory - dsar - email - employee.engagement - event.orchestration - external.contacts - external.events.data.ingestion - gamification - gcv - gdpr - groups - guides - historical.adherence - infrastructureascode - integrations - intent.miner - internal.messaging - journey - knowledge - language.understanding - learning - limit.registry - marketplace - mcp.analytics.aggregates - mcp - media.communications - messaging - micro.frontend - multi.org - notifications - onboarding - outbound - platform.api - predictive.routing - presence - quality - recording - response.management - routing - scim - screen.monitoring - search - secondary.automation.testing - skills - social.media - speech.and.text.analytics - speech.integration - supportability - task.management - telephony.configuration - usage - users - users.rules - voice.transcription - webchat - webhooks - workforce.management.adherence - workforce.management.agent.availability - workforce.management.forecast - workforce.management - workforce.management.scheduling.preferences - workforce.management.self.schedule - workforce.management.shift.trading - system value: type: integer format: int64 ResponseAssetEntityListing: type: object properties: entities: type: array description: List of response assets items: $ref: '#/definitions/ResponseAsset' notFound: type: array description: Asset IDs not found items: type: string Chat: type: object properties: jabberId: type: string GroupContact: type: object required: - address - mediaType - type properties: address: type: string description: Phone number for this contact type extension: type: string description: Extension is set if the number is e164 valid display: type: string description: Formatted version of the address property readOnly: true type: type: string description: Contact type of the address enum: - GROUPRING - GROUPPHONE mediaType: type: string description: Media type of the address enum: - PHONE Contact: type: object properties: address: type: string description: Email address or phone number for this contact type display: type: string description: Formatted version of the address property readOnly: true mediaType: type: string enum: - PHONE - EMAIL - SMS type: type: string enum: - PRIMARY - WORK - WORK2 - WORK3 - WORK4 - HOME - MOBILE - MAIN - OTHER extension: type: string description: Use internal extension instead of address. Mutually exclusive with the address field. countryCode: type: string integration: type: string example: microsoftteams description: Integration tag value if this number is associated with an external integration. LocationDefinition: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string contactUser: description: Site contact for the location entity $ref: '#/definitions/AddressableEntityRef' emergencyNumber: description: Emergency number for the location entity $ref: '#/definitions/LocationEmergencyNumber' address: $ref: '#/definitions/LocationAddress' state: type: string description: Current state of the location entity enum: - active - deleted notes: type: string description: Notes for the location entity version: type: integer format: int32 description: Current version of the location entity, value to be supplied should be retrieved by a GET or on create/update response path: type: array description: A list of ancestor IDs in order readOnly: true items: type: string profileImage: type: array description: Profile image of the location entity, retrieved with ?expand=images query parameter readOnly: true items: $ref: '#/definitions/LocationImage' floorplanImage: type: array description: Floorplan images of the location entity, retrieved with ?expand=images query parameter readOnly: true items: $ref: '#/definitions/LocationImage' addressVerificationDetails: description: Address verification information, retrieve dwith the ?expand=addressVerificationDetails query parameter readOnly: true $ref: '#/definitions/LocationAddressVerificationDetails' addressVerified: type: boolean description: Boolean field which states if the address has been verified as an actual address readOnly: true addressStored: type: boolean description: Boolean field which states if the address has been stored for E911 readOnly: true images: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true ResponseAssetSearchRequest: type: object required: - query properties: pageSize: type: integer format: int32 description: 'The number of results per page. Default: 25, Maximum: 100.' pageNumber: type: integer format: int32 description: The page of resources you want to retrieve sortOrder: type: string description: The sort order for results enum: - ASC - DESC sortBy: type: string description: The field in the resource that you want to sort the results by query: type: array description: Filter the query results. items: $ref: '#/definitions/ResponseAssetFilter' UserConversationSummary: type: object properties: userId: type: string call: $ref: '#/definitions/MediaSummary' callback: $ref: '#/definitions/MediaSummary' email: $ref: '#/definitions/MediaSummary' message: $ref: '#/definitions/MediaSummary' chat: $ref: '#/definitions/MediaSummary' socialExpression: $ref: '#/definitions/MediaSummary' video: $ref: '#/definitions/MediaSummary' Image: type: object properties: resolution: type: string description: 'Height and/or width of image. ex: 640x480 or x128' imageUri: type: string Education: type: object properties: school: type: string fieldOfStudy: type: string notes: type: string description: Notes about education has a 2000 character limit dateStart: type: string format: date description: 'Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' dateEnd: type: string format: date description: 'Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd' ErrorBody: type: object properties: message: type: string code: type: string status: type: integer format: int32 entityId: type: string entityName: type: string messageWithParams: type: string messageParams: type: object additionalProperties: type: string contextId: type: string details: type: array items: $ref: '#/definitions/Detail' errors: type: array items: $ref: '#/definitions/ErrorBody' limit: $ref: '#/definitions/Limit' LocationImage: type: object properties: resolution: type: string description: 'Height and/or width of image. ex: 640x480 or x128' imageUri: type: string Division: type: object properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string selfUri: type: string format: uri description: The URI for this object readOnly: true Library: type: object required: - name properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The library name. version: type: integer format: int32 description: Current version for this resource. createdBy: description: User that created the library. readOnly: true $ref: '#/definitions/User' dateCreated: type: string format: date-time description: 'The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true responseType: type: string description: This value is deprecated. Responses representing message templates may be added to any library. enum: - MessagingTemplate - CampaignSmsTemplate - CampaignEmailTemplate - Footer - Form - AppleInvitation division: description: The division to which this entity belongs. $ref: '#/definitions/WritableDivision' selfUri: type: string format: uri description: The URI for this object readOnly: true UserStation: type: object properties: id: type: string description: A globally unique identifier for this station readOnly: true name: type: string type: type: string associatedUser: $ref: '#/definitions/User' associatedDate: type: string format: date-time description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' defaultUser: $ref: '#/definitions/User' providerInfo: type: object description: 'Provider-specific info for this station, e.g. { "edgeGroupId": "ffe7b15c-a9cc-4f4c-88f5-781327819a49" }' additionalProperties: type: string webRtcCallAppearances: type: integer format: int32 description: The number of call appearances on the station. readOnly: true QueryCriteriaQuery: type: object required: - query properties: query: type: array description: List of criteria groups that will be AND'd together items: $ref: '#/definitions/QueryCriteriaGroup' description: Query object for searching libraries based on criteria Group: type: object required: - name - rulesVisible - type - visibility properties: id: type: string description: The globally unique identifier for the object. readOnly: true name: type: string description: The group name. description: type: string dateModified: type: string format: date-time description: 'Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z' readOnly: true memberCount: type: integer format: int64 description: Number of members. readOnly: true state: type: string description: Active, inactive, or deleted state. readOnly: true enum: - active - inactive - deleted version: type: integer format: int32 description: Current version for this resource. readOnly: true type: type: string description: Type of group. enum: - official - social images: type: array items: $ref: '#/definitions/Image' addresses: type: array items: $ref: '#/definitions/GroupContact' rulesVisible: type: boolean description: Are membership rules visible to the person requesting to view the group visibility: type: string description: Who can view this group enum: - public - owners - members rolesEnabled: type: boolean description: Allow roles to be assigned to this group includeOwners: type: boolean description: Allow owners to be included as members of the group callsEnabled: type: boolean description: Allow calls to be placed to this group. owners: type: array description: Owners of the group items: $ref: '#/definitions/User' selfUri: type: string format: uri description: The URI for this object readOnly: true Location: type: object properties: id: type: string description: Unique identifier for the location floorplanId: type: string description: Unique identifier for the location floorplan image readOnly: true coordinates: type: object description: Users coordinates on the floorplan. Only used when floorplanImage is set additionalProperties: type: number format: double notes: type: string description: Optional description on the users location locationDefinition: $ref: '#/definitions/LocationDefinition' CreateResponseAssetRequest: type: object required: - name properties: name: type: string description: 'Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \{^}%`]">[~<#|' divisionId: type: string description: Division to associate to this asset. Can only be used with this division. contentMd5: type: string description: Content MD-5 of the file to upload MessageHeader: type: object properties: type: type: string description: Defines the content type of the Header in message enum: - Text - Image - Video - Document content: type: string description: Content associated with the header in the message ResponseAssetBulkRequest: type: object required: - assetIds properties: assetIds: type: array description: List of Response Asset IDs (max 50) items: type: string maxItems: 50 minItems: 1 sortBy: type: string description: 'The field in the resource that you want to sort the results by. Allowed values: name, dateCreated, dateModified, contentLength' sortOrder: type: string description: The sort order for results enum: - asc - desc ResponseQueryResults: type: object required: - results properties: results: description: Contains the query results $ref: '#/definitions/ResponseEntityList' description: Used to return response query results LocationAddress: type: object properties: city: type: string country: type: string countryName: type: string state: type: string street1: type: string street2: type: string zipcode: type: string WhatsAppDefinition: type: object required: - language - name properties: name: type: string description: The messaging template name. namespace: type: string description: The messaging template namespace. language: type: string description: The messaging template language configured for this template. This is a WhatsApp specific value. For example, 'en_US' buttons: type: array description: List of buttons to be included in the standard WhatsApp messages channel items: $ref: '#/definitions/Button' messageFooter: description: Footer for the message in the standard WhatsApp messages channel $ref: '#/definitions/MessageFooter' header: description: Header for the message in the standard WhatsApp messages channel $ref: '#/definitions/MessageHeader' integrationId: type: string description: WhatsApp integration ID for whatsApp carousels category: type: string description: Category of whatsApp carousels template. enum: - marketing templateStatus: type: string description: Template status of whatsApp carousels template. readOnly: true statusInfo: description: Status information about the template readOnly: true $ref: '#/definitions/StatusInfo' carousel: description: Definition for whatsApp carousels template. $ref: '#/definitions/Carousel' description: A WhatsApp messaging template definition as defined in the WhatsApp Business Manager securityDefinitions: PureCloud OAuth: type: oauth2 authorizationUrl: https://login.mypurecloud.com/authorize flow: implicit scopes: all: All the scopes Guest Chat JWT: type: apiKey name: Authorization in: header externalDocs: description: PureCloud API Documentation url: https://developer.genesys.cloud/