Genesys Events API

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 Events 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: Events
  description: Events
  externalDocs:
    description: Events Documentation
    url: https://developer.genesys.cloud/api/rest/v2/events/
paths:
  /api/v2/events/conversations:
    post:
      tags:
      - Events
      summary: Publish Conversation Batch Events
      description: ''
      operationId: postEventsConversations
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: batchRequest
        required: true
        schema:
          $ref: '#/definitions/BatchConversationEventRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/BatchEventResponse'
        '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]
            zero.events.submitted: A minimum of 1 event must be submitted
            max.batch.size.surpassed: Max allowed event count per request has been surpassed. Max batch size is 100
            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:
        - conversations
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - conversation:conversation:inject
      x-purecloud-method-name: postEventsConversations
  /api/v2/events/users/routingstatus:
    post:
      tags:
      - Events
      summary: Publish Agent Routing Status Batch Events
      description: ''
      operationId: postEventsUsersRoutingstatus
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: batchRequest
        required: true
        schema:
          $ref: '#/definitions/BatchUserRoutingStatusEventRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/BatchEventResponse'
        '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]
            zero.events.submitted: A minimum of 1 event must be submitted
            max.batch.size.surpassed: Max allowed event count per request has been surpassed. Max batch size is 100
            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:
        - routing
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - routing:routingstatus:inject
      x-purecloud-method-name: postEventsUsersRoutingstatus
  /api/v2/events/users/presence:
    post:
      tags:
      - Events
      summary: Publish User Presence Status Batch Events
      description: ''
      operationId: postEventsUsersPresence
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: batchRequest
        required: true
        schema:
          $ref: '#/definitions/BatchUserPresenceEventRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/BatchEventResponse'
        '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]
            zero.events.submitted: A minimum of 1 event must be submitted
            max.batch.size.surpassed: Max allowed event count per request has been surpassed. Max batch size is 100
            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:
        - presence
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - presence:userPresence:inject
      x-purecloud-method-name: postEventsUsersPresence
definitions:
  ProgressTransferEvent:
    type: object
    required:
    - commandId
    - conversationId
    - destinationCommunicationId
    - eventDateTime
    - eventId
    - objectCommunicationId
    properties:
      eventId:
        type: string
        description: A unique (V4 UUID) eventId for this event
      eventDateTime:
        type: string
        format: date-time
        description: 'A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      conversationId:
        type: string
        description: A unique Id (V4 UUID) identifying this conversation
      commandId:
        type: string
        description: The id (V4 UUID) used to identify the transfer already started by the external platform.
      objectCommunicationId:
        type: string
        description: The id (V4 UUID) of the communication that is being transferred.
      destinationCommunicationId:
        type: string
        description: The id (V4 UUID) of the communication that is being transferred to.
  EndConsultTransferEvent:
    type: object
    required:
    - conversationId
    - eventDateTime
    - eventId
    properties:
      eventId:
        type: string
        description: A unique (V4 UUID) eventId for this event
      eventDateTime:
        type: string
        format: date-time
        description: 'A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      conversationId:
        type: string
        description: A unique Id (V4 UUID) identifying this conversation
  EmailExternalEstablishedEvent:
    type: object
    required:
    - communicationId
    - conversationId
    - eventDateTime
    - eventId
    - initialConfiguration
    - sourceConfiguration
    properties:
      eventId:
        type: string
        description: A unique (V4 UUID) eventId for this event
      eventDateTime:
        type: string
        format: date-time
        description: 'A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      conversationId:
        type: string
        description: A unique Id (V4 UUID) identifying this conversation
      communicationId:
        type: string
        description: A unique Id (V4 UUID) identifying this communication.
      displayName:
        type: string
        description: A name for the participant if it is available for this conversation.
      includeMessage:
        type: boolean
        description: Indicates that established communication has an initial email. If true, the initial messagesSent value will be initialized to 1.
      initialConfiguration:
        description: Metadata about this communication.
        $ref: '#/definitions/EmailInitialConfiguration'
      sourceConfiguration:
        description: Metadata about the source of this communication's interaction.
        $ref: '#/definitions/SourceConfiguration'
  EmailCommunicationEndedEvent:
    type: object
    required:
    - communicationId
    - conversationId
    - disconnectType
    - eventDateTime
    - eventId
    properties:
      eventId:
        type: string
        description: A unique (V4 UUID) eventId for this event
      eventDateTime:
        type: string
        format: date-time
        description: 'A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      conversationId:
        type: string
        description: A unique Id (V4 UUID) identifying this conversation
      communicationId:
        type: string
        description: A unique Id (V4 UUID) identifying this communication.
      disconnectType:
        type: string
        description: Indicates how this communication was ended.
        enum:
        - Unknown
        - Self
        - Peer
        - System
        - Error
        - Spam
        - Transfer
        - TransferACD
        - TransferUser
  EmailUserTransferEvent:
    type: object
    required:
    - commandId
    - conversationId
    - destinationUserId
    - eventDateTime
    - eventId
    - initiatingCommunicationId
    - objectCommunicationId
    - targetCommunicationId
    - transferType
    properties:
      eventId:
        type: string
        description: A unique (V4 UUID) eventId for this event
      eventDateTime:
        type: string
        format: date-time
        description: 'A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      conversationId:
        type: string
        description: A unique Id (V4 UUID) identifying this conversation
      transferType:
        type: string
        description: Indicates the desired type of transfer.
        enum:
        - Attended
        - Unattended
      commandId:
        type: string
        description: The id (V4 UUID) used by the external platform to refer to the transfer in subsequent Transfer events.
      initiatingCommunicationId:
        type: string
        description: The id (V4 UUID) of the communication representing the participant that is initiating the transfer.
      targetCommunicationId:
        type: string
        description: The id (V4 UUID) of the communication that is being transferred away from. In many cases this will be the same as the `initiatingCommunicationId`.
      objectCommunicationId:
        type: string
        description: The id (V4 UUID) of the communication that is being transferred.
      destinationUserId:
        type: string
        description: The id (V4 UUID) of the desired destination user that the object communication should be transferred to.
  InitialConfiguration:
    type: object
    properties:
      audioState:
        description: Indicates the initial audio state for the communication.
        $ref: '#/definitions/AudioState'
      alerting:
        type: boolean
        description: Indicates that this communication's initial state is alerting. If false, the communication started in a connected state.
      inbound:
        type: boolean
        description: Indicates the direction of this communication with respect to the contact center. `true` means the communication is INBOUND. `false` means the communication is OUTBOUND.
      invitedBy:
        type: string
        description: The id of the communication (the "peer") that "invited" this communication, if this occurred.
      recordingActive:
        type: boolean
        description: Indicates whether recording is active for this communication at creation.
      additionalInfo:
        type: object
        description: Additional metadata about this session which should be recorded by the platform but which will not be indexed or searchable. Primarily for diagnostic value. Any information that needs to be accessible through other components like Analytics should be moved to dedicated fields.
        additionalProperties:
          type: string
  EmailUserEstablishedEvent:
    type: object
    required:
    - communicationId
    - conversationId
    - eventDateTime
    - eventId
    - initialConfiguration
    - sourceConfiguration
    - userId
    properties:
      eventId:
        type: string
        description: A unique (V4 UUID) eventId for this event
      eventDateTime:
        type: string
        format: date-time
        description: 'A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      conversationId:
        type: string
        description: A unique Id (V4 UUID) identifying this conversation
      communicationId:
        type: string
        description: A unique Id (V4 UUID) identifying this communication.
      userId:
        type: string
        description: A unique Id (V4 UUID) identifying the user this communication belongs to.
      queueId:
        type: string
        description: A unique Id (V4 UUID) identifying the queue that the user is emailing on behalf of. Applies to outbound emails only.
      afterCallWorkRequired:
        type: boolean
        description: Indicates whether or not this user will be required to complete after call work.
      initialConfiguration:
        description: Metadata about this communication.
        $ref: '#/definitions/EmailInitialConfiguration'
      sourceConfiguration:
        description: Metadata about the source of this communication's interaction.
        $ref: '#/definitions/SourceConfiguration'
  EventError:
    type: object
    properties:
      eventId:
        type: string
        description: The eventId (V4 UUID) for the event that encountered an error.
      message:
        type: string
        description: A message describing the error.
      retryable:
        type: boolean
        description: The event for this eventId can be resubmitted if this value is true.
  AudioState:
    type: object
    properties:
      canHear:
        type: boolean
        description: Indicates that this communication's audio allows its participant to hear others.
      canSpeak:
        type: boolean
        description: Indicates that this communication's audio allows others to hear this participant.
  CommunicationEndedEvent:
    type: object
    required:
    - communicationId
    - conversationId
    - disconnectType
    - eventDateTime
    - eventId
    properties:
      eventId:
        type: string
        description: A unique (V4 UUID) eventId for this event
      eventDateTime:
        type: string
        format: date-time
        description: 'A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      conversationId:
        type: string
        description: A unique Id (V4 UUID) identifying this conversation
      communicationId:
        type: string
        description: A unique Id (V4 UUID) identifying this communication
      disconnectType:
        type: string
        description: Indicates how this communication was ended.
        enum:
        - Error
        - Peer
        - Self
        - System
        - Transfer
        - TransferACD
        - TransferConference
        - TransferConsult
        - TransferUser
      destinationConversationId:
        type: string
        description: The id (V4 UUID) of the conversation that the communication is being moved to when conversations are merged.
  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'
  EmailHoldUpdatedEvent:
    type: object
    required:
    - communicationId
    - conversationId
    - eventDateTime
    - eventId
    - held
    properties:
      eventId:
        type: string
        description: A unique (V4 UUID) eventId for this event
      eventDateTime:
        type: string
        format: date-time
        description: 'A Date Time representing the time this event occurred. Date time is represented as an ISO-8601 string. For example: yy

# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-events-api-openapi.yml