Blackbaud Participantoptions API

openapi: 3.2.0
info:
  title: 'Blackbaud SKY API: Event Participantoptions API'
  description: This API manages event information and related entities such as participant.
  version: '1.0'
  x-apievangelist-provenance:
    source: https://developer.sky.blackbaud.com/developer/apis/event
    method: assembled from Blackbaud's public API Management developer data API (operations, parameters, representations, examples, stored definitions); nothing authored
    assembled: '2026-10-14'
servers:
- url: https://api.sky.blackbaud.com/event
security:
- Bb-Api-Subscription-Key: []
  OAuth2: []
tags:
- name: Participantoptions
paths:
  /v1/participantoptions/{option_id}:
    delete:
      operationId: DeleteParticipantOption
      summary: Delete a participant option
      description: Deletes a participant option for a participant.
      parameters:
      - name: option_id
        in: path
        required: true
        schema:
          type: string
        description: The ID of the participant option.
      responses:
        '200':
          description: Returned when the operation succeeds.
        '403':
          description: Returned when the user does not have rights to delete the participant option record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Participantoptions-option_id-Delete403ApplicationJsonResponse'
              example:
              - message: The user does not have the necessary permissions for this task.
                error_name: Forbidden
                error_code: 403
                raw_message: The user does not have the necessary permissions for this task.
      tags:
      - Participantoptions
    patch:
      operationId: EditParticipantOption
      summary: Edit a participant option
      description: Edits the details about a participant option.
      parameters:
      - name: option_id
        in: path
        required: true
        schema:
          type: string
        description: The ID of the participant option.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditParticipantOption'
            example:
              option_value: Steak dinner
        description: An object that represents the event participant option to edit.
      responses:
        '200':
          description: Returned when the operation succeeds.
        '400':
          description: Returned when the specified request body is not in the appropriate format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Participantoptions-option_id-Patch400ApplicationJsonResponse'
              example:
              - message: The request body is not in the appropriate format.
                error_name: BadRequest
                error_code: 400
                raw_message: The request body is not in the appropriate format.
        '403':
          description: Returned when the user does not have rights to modify the participant option record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Participantoptions-option_id-Patch403ApplicationJsonResponse'
              example:
              - message: The user does not have the necessary permissions for this task.
                error_name: Forbidden
                error_code: 403
                raw_message: The user does not have the necessary permissions for this task.
        '404':
          description: Returned when the specified participant option is not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Participantoptions-option_id-Patch404ApplicationJsonResponse'
              example:
              - message: The requested resource could not be found.
                error_name: ResourceNotFound
                error_code: 404
                raw_message: The requested resource could not be found.
      tags:
      - Participantoptions
components:
  schemas:
    V1Participantoptions-option_id-Patch403ApplicationJsonResponse:
      type: array
      items:
        $ref: '#/components/schemas/ServiceError'
      x-apim-inline: true
    ServiceError:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          description: The description of the error.
        error_name:
          type:
          - string
          - 'null'
          description: The name of the error.
        error_code:
          type: integer
          description: The number associated with the error.
          format: int32
        raw_message:
          type:
          - string
          - 'null'
          description: The description of the error which can include argument placeholders.
        error_args:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The argument data for the placeholders.
      additionalProperties: false
      description: Explains the reason for an error.
    EditParticipantOption:
      type: object
      properties:
        option_value:
          type:
          - string
          - 'null'
          description: "The participant's response to the option. For an event participant option with an input type of <i>List</i>, this is the ID of the selected list option. \nFor an input type of <i>Boolean</i>, this is <i>true</i> or <i>false</i>. For an input type of <i>String</i>, this is the text the participant supplied."
      additionalProperties: false
      description: A participant option
    V1Participantoptions-option_id-Delete403ApplicationJsonResponse:
      type: array
      items:
        $ref: '#/components/schemas/ServiceError'
      x-apim-inline: true
    V1Participantoptions-option_id-Patch404ApplicationJsonResponse:
      type: array
      items:
        $ref: '#/components/schemas/ServiceError'
      x-apim-inline: true
    V1Participantoptions-option_id-Patch400ApplicationJsonResponse:
      type: array
      items:
        $ref: '#/components/schemas/ServiceError'
      x-apim-inline: true
  securitySchemes:
    Bb-Api-Subscription-Key:
      type: apiKey
      name: Bb-Api-Subscription-Key
      in: header
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.blackbaud.com/oauth/authorize
          tokenUrl: https://oauth2.sky.blackbaud.com/token
          scopes: {}