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

# Run a number action

> release gives the number up (a number that campaigns, agents or pools use answers 409 with the list until confirm_unassign is true; an imported number is only removed from the workspace). retry resumes setup of a number that failed to provision. test_message texts the workspace's test phone from the number. send_documents sends the carrier what it asked for. Requires write access. This operation can change workspace data or trigger an external side effect; review the request before sending it and do not retry blindly after a timeout.



## OpenAPI

````yaml /openapi.json post /api/v1/public/phone-numbers/{id}/actions
openapi: 3.1.0
info:
  description: >-
    Customer-facing API for managing outreach, leads, conversations, voice
    agents, knowledge bases, analytics, and webhooks.
  title: Sendora Public API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.sendora.ai
security: []
tags:
  - description: Leads, lead lists, importing, enriching and finding new prospects.
    name: Leads
  - description: Build, run and measure outreach, and enroll leads.
    name: Campaigns
  - description: Read and send messages, and manage who must not be contacted.
    name: Conversations
  - description: >-
      Voice and chat agents, their tools, knowledge bases, voices and website
      widgets.
    name: Agents
  - description: >-
      Start calls, and manage phone numbers, SMS registration, sending accounts
      and email domains.
    name: Calls and numbers
  - description: Webhooks, jobs, analytics and the Copilot assistant.
    name: Platform
  - description: Manage client workspaces, plans and branding.
    name: Agency
paths:
  /api/v1/public/phone-numbers/{id}/actions:
    post:
      tags:
        - Calls and numbers
      summary: Run a number action
      description: >-
        release gives the number up (a number that campaigns, agents or pools
        use answers 409 with the list until confirm_unassign is true; an
        imported number is only removed from the workspace). retry resumes setup
        of a number that failed to provision. test_message texts the workspace's
        test phone from the number. send_documents sends the carrier what it
        asked for. Requires write access. This operation can change workspace
        data or trigger an external side effect; review the request before
        sending it and do not retry blindly after a timeout.
      operationId: number_action_api_v1_public_phone_numbers__id__actions_post
      parameters:
        - description: 'The phone number''s id: the `id` from the list for this resource.'
          in: path
          name: id
          required: true
          schema:
            title: Id
            type: string
        - in: header
          name: X-API-Key
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
        - in: header
          name: Authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NumberAction'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                title: >-
                  Response Number Action Api V1 Public Phone Numbers  Id 
                  Actions Post
          description: Successful Response
        '401':
          description: The X-API-Key header is missing, invalid, expired, or revoked.
        '402':
          description: >-
            The workspace is suspended for billing, or the request would exceed
            a plan or usage limit.
        '403':
          description: >-
            The key is valid but lacks the required scope, or the workspace has
            no active plan, lacks the entitlement, or has this feature turned
            off or view-only.
        '404':
          description: >-
            The resource does not exist or is not owned by the authenticated
            workspace.
        '410':
          description: The workspace behind this key has been deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '500':
          description: >-
            An unexpected Sendora error occurred. Retry only if the operation is
            safe to repeat.
        '503':
          description: >-
            An entitlement or billing check is temporarily unavailable. Retry
            after the Retry-After interval.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - label: cURL
          lang: bash
          source: >-
            curl -X POST
            'https://api.sendora.ai/api/v1/public/phone-numbers/YOUR_ID/actions'
            -H "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json"
            \
              -d '{"action":"release"}'
        - label: Python
          lang: python
          source: >-
            import requests


            url =
            'https://api.sendora.ai/api/v1/public/phone-numbers/YOUR_ID/actions'

            headers = {'X-API-Key': '$SENDORA_API_KEY'}

            response = requests.post(url, headers=headers, json={'action':
            'release'})

            response.raise_for_status()

            print(response.json())
        - label: JavaScript
          lang: javascript
          source: >-
            const response = await
            fetch("https://api.sendora.ai/api/v1/public/phone-numbers/YOUR_ID/actions",
            {
              method: "POST",
              headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
              body: JSON.stringify({"action": "release"}),
            });

            if (!response.ok) throw new Error(await response.text());

            console.log(await response.json());
        - label: Go
          lang: go
          source: >-
            req, err := http.NewRequest("POST",
            "https://api.sendora.ai/api/v1/public/phone-numbers/YOUR_ID/actions",
            bytes.NewBufferString(`{"action": "release"}`))

            if err != nil { log.Fatal(err) }

            req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))

            req.Header.Set("Content-Type", "application/json")

            resp, err := http.DefaultClient.Do(req)

            if err != nil { log.Fatal(err) }

            defer resp.Body.Close()
components:
  schemas:
    NumberAction:
      properties:
        action:
          description: Action returned by the Sendora API.
          enum:
            - release
            - retry
            - test_message
            - send_documents
          title: Action
          type: string
        body:
          anyOf:
            - maxLength: 320
              type: string
            - type: 'null'
          description: >-
            test_message: the text to send to the workspace's test phone;
            default is a short check message
          title: Body
        confirm_unassign:
          default: false
          description: >-
            release: also remove the number from the campaigns, agents and pools
            that use it
          title: Confirm Unassign
          type: boolean
        values:
          anyOf:
            - items:
                $ref: '#/components/schemas/RegulatoryRequirementValue'
              maxItems: 20
              type: array
            - type: 'null'
          description: >-
            send_documents: [{requirement_id, field_value}] for what the carrier
            asked
          title: Values
      required:
        - action
      title: NumberAction
      type: object
    HTTPValidationError:
      properties:
        detail:
          description: Detail returned by the Sendora API.
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      required: []
      title: HTTPValidationError
      type: object
    RegulatoryRequirementValue:
      properties:
        field_value:
          description: Field value returned by the Sendora API.
          maxLength: 4096
          minLength: 1
          title: Field Value
          type: string
        requirement_id:
          description: >-
            The requirement's id, from the documents list for this number
            (include=documents).
          maxLength: 128
          minLength: 1
          title: Requirement Id
          type: string
      required:
        - requirement_id
        - field_value
      title: RegulatoryRequirementValue
      type: object
    ValidationError:
      properties:
        loc:
          description: Loc returned by the Sendora API.
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          description: Msg returned by the Sendora API.
          title: Message
          type: string
        type:
          description: Type returned by the Sendora API.
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Customer API key created in the Sendora dashboard.
      in: header
      name: X-API-Key
      type: apiKey

````

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