> ## Documentation Index > Fetch the complete documentation index at: https://docs.blujay.io/llms.txt > Use this file to discover all available pages before exploring further. # Release a phone number (reseller partners) > Reseller partner `admin` keys only, with `Blujay-Workspace` naming the customer. Releases a number you assigned into its quiet period (30 days unless agreed otherwise). Until `quiet_until` the customer keeps its history and still receives on the number, but can't send from it; queued and scheduled texts on it wait instead of sending. Then the number retires. Releasing a number that is already released returns it unchanged. The customer's webhooks receive `phone_number.released` and `phone_number.status_updated`. Any other credential gets `404`. ## OpenAPI ````yaml /api-reference/openapi.yaml delete /v1/phone-numbers/{phone_number_id} openapi: 3.1.0 info: title: Blujay API version: 1.0.0 description: >- The Blujay API lets you send and receive iMessage, RCS and SMS messages from your Blujay phone numbers, manage contacts, and receive real-time webhooks. Every response uses the same JSON envelope and carries a `trace_id` you can share with support. Authenticate with your workspace API key. servers: - url: https://api.blujay.io description: Production security: - PublicApiKey: [] tags: - name: Auth description: Check which workspace and credential a request is using. - name: Chats description: >- Direct and group conversations between your Blujay numbers and your contacts. - name: Messages description: Send, read, edit, unsend and react to messages. - name: Phone Numbers description: >- Your Blujay numbers, whether each can send right now, and their live sending limits. - name: Capability description: >- Check whether a phone number can be reached by iMessage, RCS or SMS before you send. - name: Contacts description: Create, find, update, tag, assign and opt out contacts. - name: vCards description: >- Saved contact cards that you can send in a message. Recipients get a native contact card over iMessage, SMS or RCS. - name: Team Members description: People in your workspace you can assign contacts to. - name: Workflows description: Enroll contacts in workflows you start manually. - name: Attachments description: >- Upload files once and reuse them in messages, or download files from messages. - name: Calls description: Download call recordings referenced by call webhooks. - name: Webhooks description: Subscribe to events, inspect delivery attempts and verify signatures. - name: Partners description: >- For Blujay reseller partners. A partner runs many customer workspaces through one integration. Partner keys carry a role (`admin` or `messaging`) and name a customer in the `Blujay-Workspace` header. paths: /v1/phone-numbers/{phone_number_id}: delete: tags: - Phone Numbers summary: Release a phone number (reseller partners) description: >- Reseller partner `admin` keys only, with `Blujay-Workspace` naming the customer. Releases a number you assigned into its quiet period (30 days unless agreed otherwise). Until `quiet_until` the customer keeps its history and still receives on the number, but can't send from it; queued and scheduled texts on it wait instead of sending. Then the number retires. Releasing a number that is already released returns it unchanged. The customer's webhooks receive `phone_number.released` and `phone_number.status_updated`. Any other credential gets `404`. operationId: releasePartnerCustomerPhoneNumber parameters: - $ref: '#/components/parameters/PhoneNumberId' responses: '200': description: The released number, with `released_at` and `quiet_until`. headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object required: - data properties: data: $ref: '#/components/schemas/PublicPhoneNumber' '400': description: >- The partner key didn't name a customer (`WORKSPACE_HEADER_REQUIRED`). headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': $ref: '#/components/responses/Unauthorized' '403': description: The key has the `messaging` role (`PARTNER_ROLE_FORBIDDEN`). headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': $ref: '#/components/responses/NotFound' '409': description: >- The customer is paused or closing (`CUSTOMER_PAUSED`, `CUSTOMER_CLOSING`). headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' security: - PublicApiKey: [] components: parameters: PhoneNumberId: name: phone_number_id in: path required: true schema: $ref: '#/components/schemas/PhoneNumberId' headers: XTraceID: description: >- Unique ID for this request. It matches `trace_id` in the body. Include it when you contact Blujay support. schema: $ref: '#/components/schemas/TraceId' schemas: SuccessEnvelope: type: object description: Wraps every successful response. The result is in `data`. required: - status - trace_id - timestamp properties: status: type: string enum: - success trace_id: $ref: '#/components/schemas/TraceId' timestamp: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time client_request_id: type: string description: >- Your `X-Request-ID` header value, echoed back when you send one. Not included on the send responses (`POST /v1/chats` and `POST /v1/chats/{chat_id}/messages`); keep your own mapping from your request ID to the returned message ID there. PublicPhoneNumber: type: object description: >- A Blujay number in your workspace and what it can do right now. Numbers on the Shared Free Plan omit health, limits, queue and calling readiness. additionalProperties: false required: - phone_number_id - display_number - status - line_type - access_type - send_status - capabilities - outbound_policy properties: released_at: type: string format: date-time description: Only on a number a reseller partner released. quiet_until: type: string format: date-time description: >- Only on a number a reseller partner released. It receives until then, then retires. phone_number_id: $ref: '#/components/schemas/PhoneNumberId' display_number: type: string examples: - '+15555550100' label: type: string examples: - Support line status: type: string enum: - active - unavailable line_type: type: string enum: - outbound access_type: type: string enum: - shared - dedicated description: >- `dedicated` for a number that belongs to your workspace; `shared` for a number on the Shared Free Plan. send_status: type: object description: >- Whether the number can send right now. When `allowed` is false, `reason_code` and `reason` say why. additionalProperties: false required: - allowed properties: allowed: type: boolean reason: type: string reason_code: type: string enum: - sender_retired - number_released - number_inactive - number_setup_incomplete description: > - `sender_retired`: the phone number was retired. Send from an active number. - `number_released`: a reseller partner released the number. It still receives until it retires, but can't send. Send from an active number. - `number_inactive`: the phone number isn't active. - `number_setup_incomplete`: the phone number isn't set up for messaging yet. health_status: type: object description: Dedicated-line health. Omitted on the Shared Free Plan. additionalProperties: false required: - status properties: status: type: string enum: - healthy - degraded - critical - unknown score: type: number examples: - 98 minimum: 0 maximum: 100 as_of: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time freshness: type: string examples: - fresh limits: type: object description: >- Live sending limits for a dedicated number. The values are specific to each number and change over time, so read them here each time instead of hard-coding them. Omitted on the Shared Free Plan. additionalProperties: false required: - new_contacts - daily properties: new_contacts: type: object description: >- New contacts this number has messaged today, against its daily limit. additionalProperties: false required: - used_today - limit_per_day - remaining_today - reset_at properties: used_today: type: integer minimum: 0 limit_per_day: type: integer minimum: 0 remaining_today: type: integer minimum: 0 reset_at: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time daily: type: object description: >- Messages sent today, against a recommended daily total. When `enforced` is false, the guideline is advice, not a hard limit. additionalProperties: false required: - used_today - guideline - remaining_to_guideline - enforced properties: used_today: type: integer minimum: 0 guideline: type: integer minimum: 0 remaining_to_guideline: type: integer minimum: 0 enforced: type: boolean queue: type: object description: >- Messages waiting to send from this dedicated number. Capacity is specific to each number and can change over time, so read it here each time instead of hard-coding it. When `remaining` reaches 0, sends return `429 QUEUE_FULL`. Omitted on the Shared Free Plan. additionalProperties: false required: - pending - capacity - remaining properties: pending: type: integer minimum: 0 capacity: type: integer minimum: 0 remaining: type: integer minimum: 0 capabilities: type: object additionalProperties: false required: - messaging properties: messaging: type: object additionalProperties: false required: - outbound - inbound - media_attachments - link_parts properties: outbound: type: boolean inbound: type: boolean media_attachments: type: boolean link_parts: type: boolean voice: type: object description: >- Whether this number is ready for calling. Omitted on the Shared Free Plan. additionalProperties: false required: - outbound_ready - inbound_forwarding_ready properties: outbound_ready: type: boolean inbound_forwarding_ready: type: boolean outbound_policy: type: object description: >- Sending rules for this number, such as whether it can start conversations and whether links are allowed in a chat's first message. additionalProperties: false required: - inbound_first - first_message_links_allowed - follow_up_links_allowed - daily_total_enforced properties: inbound_first: type: boolean description: >- True when this number can only message people who texted it first (Free Plan and AI Agent numbers). Skip these when you start conversations; a first send from one returns `CONTACT_NOT_VERIFIED` or `CONTACT_MUST_TEXT_FIRST`. first_message_links_allowed: type: boolean follow_up_links_allowed: type: boolean daily_total_enforced: type: boolean ErrorEnvelope: type: object description: >- Wraps every error response. Branch on `error.code`, and include `trace_id` when you contact support. required: - status - error - trace_id - timestamp properties: status: const: error error: $ref: '#/components/schemas/PublicError' trace_id: $ref: '#/components/schemas/TraceId' timestamp: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time client_request_id: type: string description: Your `X-Request-ID` header value, echoed back when you send one. PhoneNumberId: type: string examples: - phone_abc123 pattern: ^phone_[A-Za-z0-9_-]+$ TraceId: type: string examples: - trc_8f2a1c0e4b7d pattern: ^trc_[A-Za-z0-9_-]+$ PublicError: type: object required: - code - message - type - http_status - retryable - doc_url - details properties: code: type: string description: Stable, machine-readable error code. Branch on this value. examples: - RATE_LIMIT_EXCEEDED - QUEUE_UNAVAILABLE - FEATURE_NOT_ENABLED message: type: string description: Human-readable explanation. It can change, so don't parse it. type: type: string description: Broad error category. examples: - validation - auth - idempotency - rate_limit - queue - feature_gate http_status: type: integer description: The HTTP status code of the response. enum: - 400 - 401 - 403 - 404 - 409 - 413 - 415 - 422 - 429 - 500 - 502 - 503 retryable: type: boolean description: Whether sending the same request again later can succeed. doc_url: type: string format: uri description: Link to documentation for this error code. details: type: array description: >- Extra structured context, such as the fields that failed validation or the limit you hit. items: type: object additionalProperties: true retry_after: type: integer minimum: 1 description: >- Seconds to wait before retrying. Also sent as the `Retry-After` header. reset_at: type: string examples: - '2026-10-14T17:01:00.000Z' format: date-time description: When the limit you hit resets. responses: Unauthorized: description: >- The API key is missing or invalid (`UNAUTHORIZED`), revoked (`API_KEY_REVOKED`) or expired (`API_KEY_EXPIRED`). headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' NotFound: description: The resource doesn't exist or isn't in your workspace. headers: X-Trace-ID: $ref: '#/components/headers/XTraceID' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: PublicApiKey: type: http scheme: bearer bearerFormat: blu_... description: > Your workspace API key, sent as `Authorization: Bearer blu_...`. Workspace admins can find it in the Blujay app under **API**. An API key has full access to your workspace and works on every endpoint. There is no test mode: every key sends real messages and changes real data, so keep it secret and use it only from your server. Each API key can make 600 read requests and 120 write requests per minute, plus 60 attachment requests per minute. Over a limit you get `429 RATE_LIMIT_EXCEEDED` with `Retry-After`. **Reseller partner keys.** A partner key acts for one of the partner's customers when the request names it in the `Blujay-Workspace` header (the customer's `workspace_` ID). Without the header it reaches only `/v1/partner/*` and `/v1/me`. Each customer gets the limits above for each partner key, and all of a partner's requests together get ten times those limits; a `429` says which in `error.details[0].scope` (`partner_customer` or `partner`). A `messaging` key can read anything for a customer and change chats, messages, contacts, attachments and vCards; everything else needs an `admin` key (`403 PARTNER_ROLE_FORBIDDEN`). Paused or closing customers can be read but not changed (`409 CUSTOMER_PAUSED` or `CUSTOMER_CLOSING`). Any other workspace ID in the header returns `404 NOT_FOUND`; using the header with any other credential returns `400 WORKSPACE_HEADER_NOT_ALLOWED`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.