Cvent Event Cloud Audience Segments API

openapi: 3.2.0
info:
  title: Cvent Event Cloud Audience Segments API
  version: ea
  contact:
    name: Cvent Development Platform
    url: https://developers.cvent.com/
  description: 'Operations tagged Audience Segments across 2 of this provider''s published API definitions: cvent-event-cloud-rest-openapi.yml, cvent-rest-apis-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-platform.cvent.com/ea
- url: https://api-platform-eur.cvent.com/ea
tags:
- name: Audience Segments
  description: 'Audience Segments allow planners to segment their attendees into groups and

    better manage the attendee experience based on their defined segments. Audience

    Segments APIs will enable you to get, create, and update segment information.

    These APIs will also allow you to get and update attendees associated with an

    audience segment.

    '
paths:
  /attendees/{attendeeId}/audience-segments:
    parameters:
    - $ref: '#/components/parameters/attendeeId1'
    get:
      summary: List Associated Segments
      description: Gets a paginated list of ACTIVE audience segment associations for the attendee. Use the filter query parameter to filter by segment ID.
      operationId: listAttendeeAudienceSegments
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - $ref: '#/components/parameters/filter-attendee-audience-segments'
      tags:
      - Audience Segments
      security:
      - OAuth2.clientCredentials:
        - event/audience-segments:read
      - OAuth2.authorizationCode:
        - event/audience-segments:read
      responses:
        '200':
          description: Successfully retrieved list of audience segments associated with the attendee.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attendee-audience-segment-associations-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    delete:
      summary: Delete Attendee Associations
      description: disassociate an attendee from all audience segments
      operationId: disassociateAttendeeFromAudienceSegments
      tags:
      - Audience Segments
      security:
      - OAuth2.clientCredentials:
        - event/audience-segments:write
      - OAuth2.authorizationCode:
        - event/audience-segments:write
      responses:
        '204':
          description: Successfully deleted all the attendee associations.
          headers: {}
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          description: Response 429 is required for public operations with rate limiting
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /attendees/{attendeeId}/audience-segments/filter:
    parameters:
    - $ref: '#/components/parameters/attendeeId1'
    post:
      summary: List Associated Segments
      description: 'Gets a paginated list of ACTIVE audience segment associations for the attendee by sending filter in the body of the request. This method returns the same data as [GET List Associated Segments](#operation/listAttendeeAudienceSegments) but allows for longer filters.

        '
      operationId: listAssociatedAudienceSegments
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      tags:
      - Audience Segments
      security:
      - OAuth2.clientCredentials:
        - event/audience-segments:read
      - OAuth2.authorizationCode:
        - event/audience-segments:read
      requestBody:
        description: 'Use the filter property in the request body to limit results

          to data that matches your criteria. See

          [Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.


          Supported fields and operators are listed below:


          | Field            | Operators                           |

          |------------------|-------------------------------------|

          | segment.id       | `eq`, `in`                          |


          No logical operators are supported.

          '
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/filter'
            example:
              filter: segment.id in ('313097a4-143d-11e5-9f99-d0a637ee0897', '423097a4-143d-11e5-9f99-d0a637ee0897')
      responses:
        '200':
          description: Successfully retrieved list of audience segments associated with the attendee.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attendee-audience-segment-associations-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /audience-segments:
    post:
      summary: Create Audience Segment
      description: Creates an audience segment in the given event based on the details supplied in the request body.
      operationId: createAudienceSegment
      tags:
      - Audience Segments
      security:
      - OAuth2.clientCredentials:
        - event/audience-segments:write
      - OAuth2.authorizationCode:
        - event/audience-segments:write
      requestBody:
        description: Details of the audience segment you are creating.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/audience-segment-create'
      responses:
        '201':
          description: Successfully created an audience segment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/existing-audience-segment'
        '400':
          $ref: '#/components/responses/SegmentsErrorResponse'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '422':
          $ref: '#/components/responses/UnprocessableEntity1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    get:
      summary: List Audience Segments
      description: 'Gets a paginated list of audience segments for your account. By default,

        the results include all segments present, at the account level, unless you specify

        otherwise using the filter query parameter.

        '
      operationId: listAudienceSegments
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - $ref: '#/components/parameters/sort-audience-segments'
      - $ref: '#/components/parameters/filter-cross-audience-segments'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/after'
      tags:
      - Audience Segments
      security:
      - OAuth2.clientCredentials:
        - event/audience-segments:read
      - OAuth2.authorizationCode:
        - event/audience-segments:read
      responses:
        '200':
          description: Successfully retrieved list of audience segments.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/audience-segments-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /audience-segments/filter:
    post:
      summary: List Audience Segments
      description: 'Gets a paginated list of audience segments for an account by sending a filter

        in the body of the request. By default, the results include all

        audience segments at the account level unless you specify otherwise in the filter. This

        method returns the same data as

        [GET List Audience Segments](#operation/listAudienceSegments) but

        allows for longer filters.

        '
      operationId: listAudienceSegmentsPostFilter
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - $ref: '#/components/parameters/sort-audience-segments'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/after'
      tags:
      - Audience Segments
      security:
      - OAuth2.clientCredentials:
        - event/audience-segments:read
      - OAuth2.authorizationCode:
        - event/audience-segments:read
      requestBody:
        description: 'Use filter query parameters to limit results

          to data that matches your criteria. See

          [Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.


          Supported fields and operators are listed below:


          | Field            | Operators                           | Notes                                                 |

          |------------------|-------------------------------------|-------------------------------------------------------|

          | event.id         | `eq`, `in`                          | Filters the list of all segments present in an event. |

          | id               | `eq`, `in`                          |                                                       |

          | deleted          | `eq`                                |                                                       |

          | creationType     | `eq`, `in`                          |                                                       |


          The following logical operators are supported for combining filters:

          * and

          '
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/filter'
            example:
              filter: event.id eq '103097a4-143d-11e5-9f99-d0a637ee0032' and id in ('313097a4-143d-11e5-9f99-d0a637ee0897', '423097a4-143d-11e5-9f99-d0a637ee0897') and deleted eq 'false' and creationType eq 'MANUAL'
      responses:
        '200':
          description: Successfully retrieved list of audience segments.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/audience-segments-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /audience-segments/{audienceSegmentId}:
    parameters:
    - $ref: '#/components/parameters/audienceSegmentId'
    get:
      summary: Get Audience Segment
      description: Gets an audience segment based on the given ID.
      operationId: getAudienceSegmentById
      tags:
      - Audience Segments
      security:
      - OAuth2.clientCredentials:
        - event/audience-segments:read
      - OAuth2.authorizationCode:
        - event/audience-segments:read
      responses:
        '200':
          description: Successfully retrieved the given audience segment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/audience-segment-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    put:
      summary: Update Audience Segment
      description: Updates the given audience segment based on the values provided in the request body.
      operationId: updateAudienceSegment
      tags:
      - Audience Segments
      security:
      - OAuth2.clientCredentials:
        - event/audience-segments:write
      - OAuth2.authorizationCode:
        - event/audience-segments:write
      requestBody:
        description: Audience segment fields you are updating.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/audience-segment'
      responses:
        '200':
          description: Successfully updated the given Audience segment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/existing-audience-segment'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '422':
          $ref: '#/components/responses/UnprocessableEntity1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    delete:
      summary: Delete Audience Segment
      description: Deletes the given audience segment.
      operationId: deleteAudienceSegment
      tags:
      - Audience Segments
      security:
      - OAuth2.clientCredentials:
        - event/audience-segments:write
      - OAuth2.authorizationCode:
        - event/audience-segments:write
      responses:
        '204':
          description: Successfully deleted the given audience segment.
          headers: {}
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /audience-segments/{audienceSegmentId}/attendees:
    parameters:
    - $ref: '#/components/parameters/audienceSegmentId'
    get:
      summary: List Associated Attendees
      description: 'Gets a paginated list of attendees associated or disassociated to/from an audience segment. Use the `filter` query parameter to return only associated or only disassociated attendees.

        '
      operationId: listSegmentAssociatedAttendees
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/filter-associated-attendees'
      - $ref: '#/components/parameters/includeDisassociated'
      tags:
      - Audience Segments
      security:
      - OAuth2.clientCredentials:
        - event/audience-segments:read
      - OAuth2.authorizationCode:
        - event/audience-segments:read
      responses:
        '200':
          description: Successfully retrieved list of attendees associated/disassociated to/from an audience segment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/segment-attendees-associated-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /audience-segments/{audienceSegmentId}/attendees/{attendeeId}:
    parameters:
    - $ref: '#/components/parameters/audienceSegmentId'
    - $ref: '#/components/parameters/attendeeId1'
    put:
      summary: Associate Attendee to Segment
      description: Associates an attendee to a given audience segment.
      operationId: associateAttendeeToSegment
      tags:
      - Audience Segments
      security:
      - OAuth2.clientCredentials:
        - event/audience-segments:write
      - OAuth2.authorizationCode:
        - event/audience-segments:write
      responses:
        '204':
          description: Successfully associated an attendee.
          headers: {}
        '400':
          $ref: '#/components/responses/SegmentsErrorResponse'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '422':
          $ref: '#/components/responses/UnprocessableEntity1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    delete:
      summary: Disassociate Attendee
      description: Disassociate an attendee from an audience segment.
      operationId: disassociateAttendeeFromAudienceSegment
      tags:
      - Audience Segments
      security:
      - OAuth2.clientCredentials:
        - event/audience-segments:write
      - OAuth2.authorizationCode:
        - event/audience-segments:write
      responses:
        '204':
          description: Successfully disassociated an attendee.
          headers: {}
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
components:
  parameters:
    filter-cross-audience-segments:
      name: filter
      in: query
      required: true
      description: 'Use filter query parameters to limit results

        to data that matches your criteria. See

        [Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.


        Supported fields and operators are listed below:


        | Field            | Operators                           | Notes                                                 |

        |------------------|-------------------------------------|-------------------------------------------------------|

        | event.id         | `eq`, `in`                          | Filters the list of all segments present in an event. |

        | id               | `eq`, `in`                          |                                                       |

        | deleted          | `eq`                                |                                                       |

        | creationType     | `eq`, `in`                          |                                                       |


        The following logical operators are supported for combining filters:

        * and

        '
      schema:
        type: string
        example: event.id eq '103097a4-143d-11e5-9f99-d0a637ee0032' and id in ('313097a4-143d-11e5-9f99-d0a637ee0897','423097a4-143d-11e5-9f99-d0a637ee0897') and deleted eq 'false' and creationType eq 'MANUAL'
    attendeeId1:
      in: path
      name: attendeeId
      description: ID of an attendee.
      required: true
      schema:
        $ref: '#/components/schemas/uuid-property'
    filter-attendee-audience-segments:
      name: filter
      in: query
      required: false
      description: 'Use filter query parameters to limit results

        to data that matches your criteria. See

        [Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.


        Supported fields and operators are listed below:


        | Field            | Operators                           |

        |------------------|-------------------------------------|

        | segment.id       | `eq`, `in`                          |


        No logical operators are supported.

        '
      schema:
        type: string
        example: segment.id eq '313097a4-143d-11e5-9f99-d0a637ee0897'
    after:
      name: after
      required: false
      description: Used to query records that have been added or updated after this time point. Default to the beginning of time of the data store.
      in: query
      schema:
        type: string
        format: date-time
        example: '2017-01-02T02:00:00Z'
    token:
      name: token
      in: query
      description: 'The continuation token returned from a previous class. This must be a valid UUID v4 if provided.

        This will override any other pageable parameters provided.

        '
      style: form
      explode: true
      schema:
        type: string
        example: 0e28af57-511f-47ab-ae46-46cd1ca51a1a
    sort-audience-segments:
      name: sort
      required: false
      in: query
      style: form
      explode: false
      description: "The sort order passed as a parameter, used to control the order of the\nsearch results as a priority ordered list of sorts. By default, data is sorted by lastModified ASC.\n\nThere are two orders:\n  * ascending: ASC\n  * descending: DESC\n\nThe following fields are sortable:\n  * name\n  * lastModified\n  * lastModifiedBy\n  * creationType\n"
      schema:
        type: string
        example: lastModifiedBy:DESC
    filter-associated-attendees:
      name: filter
      in: query
      required: false
      description: 'Use filter query parameters to limit results

        to data that matches your criteria. See

        [Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.


        Supported fields and operators are listed below:


        | Field            | Operators                           | Notes                                    |

        |------------------|-------------------------------------|------------------------------------------|

        | disassociated    | `eq`                                | To use this filter, `includeDisassociated` query parameter must be true. |

        '
      schema:
        type: string
        example: disassociated eq 'false'
    includeDisassociated:
      in: query
      name: includeDisassociated
      description: 'Use the `includeDisassociated` query parameter to include disassociated attendees in the result. Note: Disassociated attendees older than 30 days will not be returned in result.

        '
      required: false
      schema:
        type: boolean
        default: false
        example: true
    audienceSegmentId:
      in: path
      name: audienceSegmentId
      description: ID of an audience segment.
      required: true
      schema:
        $ref: '#/components/schemas/uuid-property'
    before:
      name: before
      required: false
      in: query
      description: Used to query records that have been added or updated before this time point.
      schema:
        type: string
        format: date-time
        example: '2017-01-02T02:00:00Z'
    limit:
      name: limit
      in: query
      description: The maximum number of records to return per page.
      style: form
      explode: true
      schema:
        maximum: 200
        minimum: 1
        type: integer
        default: 100
        example: 100
  schemas:
    filter:
      title: A filter sent in the body of a request
      description: A filter which is sent through the body of the request.
      type: object
      properties:
        filter:
          type: string
          example: property eq 'value'
          description: Filter included in the request.
    segment.json:
      title: Segment
      required:
      - id
      description: 'Segment details '
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Segment Id
          example: b13497ea-c117-4d62-a17b-e6c14d7e49d4
    link.json:
      title: Link
      required:
      - href
      type: object
      description: Represents a link to a related resource.
      properties:
        href:
          type: string
          description: A url provided that can be followed for linking
          example: ?token=90c5f062-76ad-4ea4-aa53-00eb698d9262
    segment-attendee-response.json:
      title: SegmentAttendee
      description: Represents the attendees that are associated/disassociated to/from a segment
      type: object
      allOf:
      - $ref: '#/components/schemas/attendee-segment/allOf/0'
      properties:
        segment:
          $ref: '#/components/schemas/segment.json'
        id:
          type: string
          format: uuid
          description: ID of the attendee.
          example: 103097a4-143d-11e5-9f99-d0a637ee0032
        disassociated:
          type: boolean
          description: Represents whether the attendee is dissociated from the segment. True if the attendee is disassociated from the segment, false if the attendee is associated with the segment.
          readOnly: true
          example: false
    uuid-property:
      title: UUID Property
      description: A string that has to be a format matching the industry standard uuid
      type: string
      format: uuid
      example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
    ErrorResponse:
      title: ErrorResponse
      description: Represents an error response with additional details of cascading error messages.
      allOf:
      - $ref: '#/components/schemas/ErrorResponseBase'
      type: object
      required:
      - code
      - message
      properties:
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseBase'
          description: Additional details of cascading error messages.
    attendee-segment:
      title: AttendeeSegment
      required:
      - eventId
      - name
      description: Represents an attendee segment. Attendee segments are assigned to events and provide the ability for planners to segment their attendees into groups and better manage the attendee experience based on their defined segments.
      allOf:
      - title: Audit
        description: Audit information
        type: object
        properties:
          created:
            type: string
            format: date-time
            description: The ISO 8601 zoned date time when this record was created.
            readOnly: true
            example: '2017-01-02T02:00:00Z'
          createdBy:
            type: string
            description: The identifier of the user that created this record.
            readOnly: true
            example: hporter
          lastModified:
            type: string
            format: date-time
            description: The ISO 8601 zoned date time when this record was updated.
            readOnly: true
            example: '2019-02-12T03:00:00Z'
          lastModifiedBy:
            type: string
            description: The identifier of the user that last updated this record.
            readOnly: true
            example: hporter
      type: object
      properties:
        eventId:
          type: string
          format: uuid
          description: ID of the event where the attendee segment exists.
          example: 103097a4-143d-11e5-9f99-d0a637ee0032
        name:
          type: string
          description: Name of the attendee segment. Must be unique in the event where the segment exists.
          maxLength: 100
          example: VIP Attendees
        description:
          type: string
          description: Description of the attendee segment.
          maxLength: 2500
          example: A group of VIP attendees.
        status:
          type: string
          description: 'Status of the attendee segment. ACTIVE: This attendee segment is active and in use. INACTIVE: This attendee segment is marked as inactive.'
          example: ACTIVE
          enum:
          - ACTIVE
          - INACTIVE
          default: ACTIVE
    segments-error-response:
      title: SegmentsErrorResponse
      description: Segments error response details.
      allOf:
      - title: ErrorResponse
        description: Represents an error response with additional details of cascading error messages.
        allOf:
        - title: ErrorResponseBase
          type: object
          description: Represents an error response with no additional details.
          required:
          - code
          - message
          properties:
            code:
              type: integer
              description: The HTTP status code representing the error.
              example: 400
            message:
              type: string
              description: A brief description of the error.
              example: Bad Request
            target:
              type: string
              description: The target resource of the error.
              example: example target
        type: object
        required:
        - code
        - message
        properties:
          details:
            type: array
            items:
              $ref: '#/components/schemas/segments-error-response/allOf/0/allOf/0'
            description: Additional details of cascading error messages.
      type: object
      properties:
        validationCode:
          type: string
          description: Business validation code for bad requests.
          example: SEGMENTS_PER_EVENT_LIMIT_REACHED
          enum:
          - ATTENDEES_PER_SEGMENT_LIMIT_REACHED
          - DUPLICATE_SEGMENT_NAME
          - ERROR_CHECKING_CONNECTION_TO_LINKEDIN
          - SEGMENT_CONNECTED_TO_LINKEDIN
          - SEGMENTS_PER_ATTENDEE_LIMIT_REACHED
          - SEGMENTS_PER_EVENT_LIMIT_REACHED
    event.json:
      title: Event
      required:
      - id
      description: ID of the event.
      type: object
      properties:
        id:
          type: string
          format: uuid
          desc

# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cvent-event-cloud/refs/heads/main/openapi/cvent-event-cloud-audience-segments-api-openapi.yml