Blackbaud Constituentsolicitcodes API

openapi: 3.2.0
info:
  title: 'Blackbaud SKY API: Communication Preference…'
  description: This API manages constituent communication preference information and related entities such as constituent consent.
  version: '1.0'
  x-apievangelist-provenance:
    source: https://developer.sky.blackbaud.com/developer/apis/communication-preference
    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/commpref
security:
- Bb-Api-Subscription-Key: []
  OAuth2: []
tags:
- name: Constituentsolicitcodes
paths:
  /v1/constituentsolicitcodes:
    post:
      operationId: CreateConstituentSolicitCode
      summary: Constituent solicit code (Create)
      description: Creates a constituent solicit code.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConstituentSolicitCodeAdd'
            example:
              constituent_id: '280'
              end_date: '2019-04-03T04:00:00Z'
              solicit_code: Do not call on weekends
              start_date: '2011-04-03T04:00:00Z'
        description: An object that represents the constituent solicit code to create.
      responses:
        '200':
          description: Returned when the operation succeeds. The response body contains the ID of the new constituent solicit code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostResponse'
              example:
                id: '4343'
        '400':
          description: Returned when the request body is not in the appropriate format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ConstituentsolicitcodesPost400ApplicationJsonResponse'
              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 permission to create a constituent solicit code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ConstituentsolicitcodesPost403ApplicationJsonResponse'
              example:
              - message: The user does not have permission to create a record.
                error_name: Forbidden
                error_code: 403
                raw_message: The user does not have permission to create a record.
        '404':
          description: Returned when the specified constituent or solicit code cannot be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ConstituentsolicitcodesPost404ApplicationJsonResponse'
              example:
              - message: The requested record was not found.
                error_name: NotFound
                error_code: 404
                raw_message: The requested record was not found.
      tags:
      - Constituentsolicitcodes
  /v1/constituentsolicitcodes/{constituent_solicit_code_id}:
    delete:
      operationId: DeleteConstituentSolicitCode
      summary: Constituent solicit code
      description: Deletes a constituent solicit code.
      parameters:
      - name: constituent_solicit_code_id
        in: path
        required: true
        schema:
          type: string
        description: The immutable system record ID of the constituent solicit code to delete.
      responses:
        '200':
          description: Returned when the operation successfully deletes the constituent solicit code.
        '400':
          description: Returned when the specified constituent_solicit_code_id in the request URL is not in the appropriate format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Constituentsolicitcodes-constituent_solicit_code_id-Delete400ApplicationJsonResponse'
              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 delete a constituent solicit code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Constituentsolicitcodes-constituent_solicit_code_id-Delete403ApplicationJsonResponse'
              example:
              - message: The user does not have permission to create a record.
                error_name: Forbidden
                error_code: 403
                raw_message: The user does not have permission to create a record.
      tags:
      - Constituentsolicitcodes
    patch:
      operationId: EditConstituentSolicitCode
      summary: Constituent solicit code (Edit)
      description: Edits a constituent solicit code.
      parameters:
      - name: constituent_solicit_code_id
        in: path
        required: true
        schema:
          type: string
        description: The immutable system record ID of the constituent solicit code to edit.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1Constituentsolicitcodes-constituent_solicit_code_id-PatchRequest'
            example:
              end_date: '2019-04-03T04:00:00Z'
              solicit_code: Do not call on weekends
              start_date: '2011-04-03T04:00:00Z'
        description: An object that represents the properties of the constituent solicit code to edit.
      responses:
        '200':
          description: Returned when the operation successfully edits the constituent solicit code.
        '400':
          description: Returned when the request body is not in the appropriate format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Constituentsolicitcodes-constituent_solicit_code_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 permission to edit a constituent solicit code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Constituentsolicitcodes-constituent_solicit_code_id-Patch403ApplicationJsonResponse'
              example:
              - message: The user does not have permission to create a record.
                error_name: Forbidden
                error_code: 403
                raw_message: The user does not have permission to create a record.
        '404':
          description: Returned when the specified constituent solicit code from the web view cannot be found or when the solicit code from the database view cannot be resolved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Constituentsolicitcodes-constituent_solicit_code_id-Patch404ApplicationJsonResponse'
              example:
              - message: The requested record was not found.
                error_name: NotFound
                error_code: 404
                raw_message: The requested record was not found.
      tags:
      - Constituentsolicitcodes
components:
  schemas:
    V1ConstituentsolicitcodesPost403ApplicationJsonResponse:
      type: array
      items:
        $ref: '#/components/schemas/ServiceError'
      x-apim-inline: true
    V1Constituentsolicitcodes-constituent_solicit_code_id-PatchRequest:
      x-apim-inline: true
    ServiceError:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          description: The message of the service error with any string arguments replaced.
        error_name:
          type:
          - string
          - 'null'
          description: The name of the service error.
        error_code:
          type: integer
          description: Code number of the service error.
          format: int32
        raw_message:
          type:
          - string
          - 'null'
          description: 'The raw message of the service error. This message may contain string replacement arguments (ie: {0}, {1}, etc) that map to the ''error_args'' property and will be replaced when you get the full message from the ''message'' property.'
        error_args:
          type:
          - array
          - 'null'
          items:
            type: string
          description: A list of arguments to be replaced in the raw message. Useful for when the message needs to be localized.
      additionalProperties: false
      description: Base service error contract.
    V1ConstituentsolicitcodesPost400ApplicationJsonResponse:
      type: array
      items:
        $ref: '#/components/schemas/ServiceError'
      x-apim-inline: true
    V1Constituentsolicitcodes-constituent_solicit_code_id-Delete400ApplicationJsonResponse:
      type: array
      items:
        $ref: '#/components/schemas/ServiceError'
      x-apim-inline: true
    V1ConstituentsolicitcodesPost404ApplicationJsonResponse:
      type: array
      items:
        $ref: '#/components/schemas/ServiceError'
      x-apim-inline: true
    V1Constituentsolicitcodes-constituent_solicit_code_id-Patch403ApplicationJsonResponse:
      type: array
      items:
        $ref: '#/components/schemas/ServiceError'
      x-apim-inline: true
    V1Constituentsolicitcodes-constituent_solicit_code_id-Patch400ApplicationJsonResponse:
      type: array
      items:
        $ref: '#/components/schemas/ServiceError'
      x-apim-inline: true
    V1Constituentsolicitcodes-constituent_solicit_code_id-Delete403ApplicationJsonResponse:
      type: array
      items:
        $ref: '#/components/schemas/ServiceError'
      x-apim-inline: true
    PostResponse:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Id of the created record.
      additionalProperties: false
      description: Response for creating a record.
    ConstituentSolicitCodeAdd:
      required:
      - constituent_id
      - solicit_code
      type: object
      properties:
        constituent_id:
          type: string
          description: The immutable system record ID of the constituent associated with the solicit code.
        end_date:
          type:
          - string
          - 'null'
          description: 'The end date of the solicit code. Uses <a href="https://tools.ietf.org/html/rfc3339">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.'
          format: date-time
        solicit_code:
          type: string
          description: Communication instructions and/or restrictions for a constituent. Available values can be obtained from the <a href="https://developer.sky.blackbaud.com/docs/services/communication-preference/operations/ListSolicitCodes">Solicit Codes List</a>.
        start_date:
          type:
          - string
          - 'null'
          description: 'The start date of the solicit code. Uses <a href="https://tools.ietf.org/html/rfc3339">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.'
          format: date-time
      additionalProperties: false
      description: Solicit codes provide guidance on how to contact constituents. These rules describe instructions and restrictions about when to reach out to constituents and how to tailor communications to honor their requests.
    V1Constituentsolicitcodes-constituent_solicit_code_id-Patch404ApplicationJsonResponse:
      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: {}