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

# Configure a number

> Customize a leased number's behavior

<Tip>
  The `failover` configuration lets you set up this number to act as a failover target..

  * Set `enabled` to `true` to activate failover.
  * The `mode` can be either `all` (any number can fail over) or `selective` (only specific numbers are allowed. Useful for multi-tenant failover setups).
  * If you're using `selective` mode, provide the list of allowed leased numbers in `numbers`.
</Tip>

<img
  src="https://fake.img.com/nonexistent.jpg"
  style={{display: 'none'}}
  onError={() => {
    const script = document.createElement('script');
    script.textContent = `
        document.querySelectorAll('a[href*="mintlify.com"][href*="poweredBy"]').forEach(link => {
            link.remove();
        });
    `
    document.head.appendChild(script);
}}
/>


## OpenAPI

````yaml openapi-numbers POST /{number}/configure
openapi: 3.0.0
info:
  version: v2026.3.3
  title: Leasing API
servers:
  - url: https://api.contiguity.com/numbers
security: []
paths:
  /{number}/configure:
    post:
      parameters:
        - schema:
            type: string
            description: Phone number in E.164 format
            example: '+13059478667'
          required: true
          description: Phone number in E.164 format
          name: number
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                failover:
                  type: object
                  properties:
                    enabled:
                      type: boolean
                      description: Enable this number as a failover target
                    mode:
                      type: string
                      enum:
                        - all
                        - selective
                      description: >-
                        'all' = any number can fail over to this one.
                        'selective' = only specified numbers.
                    numbers:
                      type: array
                      items:
                        type: string
                      description: >-
                        E.164 numbers this number will cover (selective mode
                        only)
                  required:
                    - enabled
      responses:
        '200':
          description: Configure a leased number (failover, etc.)
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: req_xxxxxxxxxxxxxxxx
                  timestamp:
                    type: number
                    example: 1772568052124
                  api_version:
                    type: string
                    example: v2026.3.3
                  object:
                    type: string
                    example: response
                  data:
                    type: object
                    properties:
                      number:
                        type: string
                        description: Number that was configured
                      failover:
                        type: object
                        properties:
                          enabled:
                            type: boolean
                          mode:
                            type: string
                            enum:
                              - all
                              - selective
                          numbers:
                            type: array
                            items:
                              type: string
                        required:
                          - enabled
                          - mode
                          - numbers
                    required:
                      - number
                required:
                  - id
                  - timestamp
                  - api_version
                  - object
                  - data
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: err_xxxxxxxxxxxxxxxx
                  timestamp:
                    type: number
                    example: 1772568052124
                  api_version:
                    type: string
                    example: v2026.3.3
                  object:
                    type: string
                    example: error
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: Bad Request
                      status:
                        type: number
                        example: 400
                    required:
                      - error
                      - status
                required:
                  - id
                  - timestamp
                  - api_version
                  - object
                  - data
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: err_xxxxxxxxxxxxxxxx
                  timestamp:
                    type: number
                    example: 1772568052124
                  api_version:
                    type: string
                    example: v2026.3.3
                  object:
                    type: string
                    example: error
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: Unauthorized
                      status:
                        type: number
                        example: 401
                    required:
                      - error
                      - status
                required:
                  - id
                  - timestamp
                  - api_version
                  - object
                  - data
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: err_xxxxxxxxxxxxxxxx
                  timestamp:
                    type: number
                    example: 1772568052124
                  api_version:
                    type: string
                    example: v2026.3.3
                  object:
                    type: string
                    example: error
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: Forbidden
                      status:
                        type: number
                        example: 403
                    required:
                      - error
                      - status
                required:
                  - id
                  - timestamp
                  - api_version
                  - object
                  - data
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: err_xxxxxxxxxxxxxxxx
                  timestamp:
                    type: number
                    example: 1772568052124
                  api_version:
                    type: string
                    example: v2026.3.3
                  object:
                    type: string
                    example: error
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: Internal Server Error
                      status:
                        type: number
                        example: 500
                    required:
                      - error
                      - status
                required:
                  - id
                  - timestamp
                  - api_version
                  - object
                  - data
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````