Blackbaud Aliases API

openapi: 3.2.0
info:
  title: 'Blackbaud SKY API: Constituent Aliases API'
  description: This API manages constituent information and related entities such as addresses, phones, emails, and notes.
  version: '1.0'
  x-apievangelist-provenance:
    source: https://developer.sky.blackbaud.com/developer/apis/56b76470069a0509c8f1c5b3
    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/constituent/v1
security:
- Bb-Api-Subscription-Key: []
  OAuth2: []
tags:
- name: Aliases
paths:
  /aliases:
    post:
      operationId: CreateConstituentAlias
      summary: Alias (Create)
      description: Creates an alias.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AliasAdd'
            example:
              constituent_id: '246'
              name: Davis
              type: Maiden Name
        description: An object that represents the alias to create.
      responses:
        '200':
          description: Returned when the operation successfully creates an alias. The response body contains the ID of the new alias.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostResponse'
              example:
                id: '1281'
        '400':
          description: Returned when the request body is not in the appropriate format.
        '403':
          description: Returned when the user does not have permission to create the alias.
        '404':
          description: Returned when the specified constituent is not found.
      tags:
      - Aliases
  /aliases/{alias_id}:
    delete:
      operationId: DeleteConstituentAlias
      summary: Alias (Delete)
      description: Deletes an alias.
      parameters:
      - name: alias_id
        in: path
        required: true
        schema:
          type: string
        description: The immutable system record ID of the alias to delete.
      responses:
        '200':
          description: Returned when the operation successfully deletes the alias.
        '400':
          description: Returned when the specified alias ID in the request URL is not in the appropriate format.
        '403':
          description: Returned when the user does not have permission to delete the alias.
      tags:
      - Aliases
    patch:
      operationId: EditConstituentAlias
      summary: Alias (Edit)
      description: Edits an alias for a constituent.
      parameters:
      - name: alias_id
        in: path
        required: true
        schema:
          type: string
        description: The immutable system record ID of the alias to edit.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AliasEdit'
            example:
              name: Daniels
              type: Maiden Name
        description: An object that represents the properties of the alias to edit.
      responses:
        '200':
          description: Returned when the operation successfully edits the alias.
        '400':
          description: Returned when the specified alias ID in the request URL or the specified request parameters are not in the appropriate format.
        '404':
          description: Returned when the specified alias is not found.
      tags:
      - Aliases
components:
  schemas:
    PostResponse:
      description: Defines the shape of a post response object.
      type: object
      properties:
        id:
          description: The newly created ID
          type: string
      x-hidden: true
    AliasEdit:
      description: Aliases provide secondary identification for individuals or organizations. For example, aliases can be stage names or acronyms.
      type: object
      properties:
        name:
          description: 'The name to use as the constituent''s alias. Character limit: 100. This property cannot be set to null.'
          maxLength: 100
          minLength: 0
          type: string
        type:
          description: The alias type. Available values are the active entries in the <a href="https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListAliasTypes"><b>Alias Types</b></a> table.
          type: string
      x-hidden: true
      x-display-name: Edit alias
      x-display-id: EditAlias
    AliasAdd:
      description: Aliases provide secondary identification for individuals or organizations. For example, aliases can be stage names or acronyms.
      required:
      - constituent_id
      - name
      type: object
      properties:
        constituent_id:
          description: The immutable system record ID of the constituent associated with the alias.
          type: string
        name:
          description: 'The name to use as the constituent''s alias. Character limit: 100.'
          maxLength: 100
          minLength: 0
          type: string
        type:
          description: The alias type. Available values are the active entries in the <a href="https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListAliasTypes"><b>Alias Types</b></a> table.
          type: string
      x-hidden: true
      x-display-name: Create alias
      x-display-id: CreateAlias
  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: {}