> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getprosperapp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Add Blacklist Phone Number

> 201 when the number is added, 200 when it was already there.



## OpenAPI

````yaml https://voice.getprosperapp.com/openapi.json post /api/v1/blacklists/{blacklist_id}/phone-numbers/{phone_number}
openapi: 3.1.0
info:
  title: Prosper Voice
  version: 1.0.0
servers: []
security: []
paths:
  /api/v1/blacklists/{blacklist_id}/phone-numbers/{phone_number}:
    post:
      tags:
        - Blacklists
      summary: Add Blacklist Phone Number
      description: 201 when the number is added, 200 when it was already there.
      operationId: >-
        add_blacklist_phone_number_api_v1_blacklists__blacklist_id__phone_numbers__phone_number__post
      parameters:
        - name: blacklist_id
          in: path
          required: true
          schema:
            type: string
            description: The blacklist to add to.
            title: Blacklist Id
          description: The blacklist to add to.
        - name: phone_number
          in: path
          required: true
          schema:
            type: string
            description: >-
              The number to add, E.164. Compared to the list exactly as written,
              so send it in the same form you read back from GET.
            title: Phone Number
          description: >-
            The number to add, E.164. Compared to the list exactly as written,
            so send it in the same form you read back from GET.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddBlacklistPhoneNumberRequest'
      responses:
        '200':
          description: The number was already on the list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlacklistPhoneNumberResponse'
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlacklistPhoneNumberResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AddBlacklistPhoneNumberRequest:
      properties:
        reason:
          $ref: '#/components/schemas/BlacklistedPhoneNumberReason'
          description: >-
            Why the number is on the list. This is what the platform acts on:
            inbound-fallback reasons route the caller to a person, the rest stop
            us contacting them.
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Optional label shown beside the number.
        comment:
          anyOf:
            - type: string
            - type: 'null'
          title: Comment
          description: >-
            Optional free text. Worth saying where the number came from, since
            whoever reads the list next will not know.
        level:
          anyOf:
            - $ref: '#/components/schemas/BlacklistedPhoneNumberLevel'
            - type: 'null'
          description: >-
            Severity. Ignored for inbound-fallback reasons, which are always
            stored critical_risk so the nightly cleanup cannot expire them. Omit
            it to keep what the number already has, or high_risk if it is new.
      type: object
      required:
        - reason
      title: AddBlacklistPhoneNumberRequest
    BlacklistPhoneNumberResponse:
      properties:
        phone_number:
          type: string
          title: Phone Number
          description: The number as stored.
        reason:
          type: string
          title: Reason
          description: Why the number is on the list.
        level:
          type: string
          title: Level
          description: Severity.
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Label, if one was given.
        comment:
          anyOf:
            - type: string
            - type: 'null'
          title: Comment
          description: Free text, if any was given.
      type: object
      required:
        - phone_number
        - reason
        - level
        - name
        - comment
      title: BlacklistPhoneNumberResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    BlacklistedPhoneNumberReason:
      type: string
      enum:
        - HUMAN_ONLY
        - UNPROCESSABLE_BY_PHONE
        - WRONG_PHONE_NUMBER
        - IVR_LOOP
        - SERVICE_NOT_AVAILABLE
        - DISCONNECTED
        - INPUT_DATA_ISSUE
        - NOT_FOUND
        - MEMBER_CONSENT_REQUIRED
        - NOT_ALL_DATA_POINTS_RETRIEVED
        - DNC_REQUESTED
        - NOT_INTERESTED_RIGHT_NOW
        - WRONG_USER
        - MANAGER_REQUESTED
        - PROVIDER_NO_LONGER_AT_LOCATION
        - DATA_ISSUE
        - TRANSFER_HANG_UP
        - SMS_OPT_OUT
        - TWILIO_OPT_OUT
        - INBOUND_HUMAN_REQUESTED
        - INBOUND_PRIORITY_CALLER
      title: BlacklistedPhoneNumberReason
    BlacklistedPhoneNumberLevel:
      type: string
      enum:
        - low_risk
        - high_risk
        - critical_risk
      title: BlacklistedPhoneNumberLevel
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.