Sendblue

https://docs.sendblue.com
Admin
Sendblue is an iMessage, SMS, and MMS API platform that enables businesses to send and receive...
Tokens:267,315
Snippets:1,908
Trust Score:7.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install Sendblue CLI and run setup

Source: https://docs.sendblue.com/getting-started

Installs the Sendblue CLI globally and runs the interactive setup to create an account, assign a Sendblue number, and verify a contact.

```bash
npm install -g @sendblue/cli
sendblue setup
```

--------------------------------

### Install Sendblue CLI and run setup

Source: https://docs.sendblue.com/getting-started/quickstart

Installs the Sendblue CLI globally and runs the interactive setup to create a free account, assign a shared Sendblue line, generate API keys, and save credentials locally. No credit card is required.

```bash
npm install -g @sendblue/cli
sendblue setup

```

--------------------------------

### openclaw-sendblue get credentials

Source: https://docs.sendblue.com/getting-started

Installs the Sendblue CLI, runs setup, and shows API keys for openclaw-sendblue.

```bash
npm install -g @sendblue/cli
sendblue setup
sendblue show-keys
```

--------------------------------

### Set up account with email verification

Source: https://docs.sendblue.com/getting-started/credentials

Starts the interactive setup flow for new accounts using email verification.

```bash
sendblue setup
```

--------------------------------

### Bootstrap sandbox with npx @sendblue/cli sandbox init

Source: https://docs.sendblue.com/sandboxes

Run this command to start the sandbox setup challenge. The CLI prints a Sendblue number and an SB SETUP phrase, waits for the human to send that phrase, saves API keys locally, and creates the first sandbox.

```bash
npx -y @sendblue/cli@latest sandbox init
```

--------------------------------

### Sandbox setup with Sendblue CLI

Source: https://docs.sendblue.com/llms.txt

Initializes a sandbox and connects a phone number. The first command starts the sandbox without credentials; the second relays the shown Sendblue number and SB SETUP code to the human who texts it from the phone they want to verify.

```bash
npx -y @sendblue/cli@latest sandbox init
# Relay the shown Sendblue number and SB SETUP code; the human texts it from the phone they want to verify.
npx -y @sendblue/cli@latest sandbox connect
```

--------------------------------

### Isolate signup credentials and run sandbox init

Source: https://docs.sendblue.com/sandboxes

Sets SENDBLUE_HOME to a temporary directory and HOME to it, isolating credentials from any existing Sendblue login, then runs `npx -y @sendblue/cli@latest sandbox init` to start the text verification setup.

```bash
export SENDBLUE_HOME="${SENDBLUE_HOME:-${TMPDIR:-/tmp}/sendblue-sandbox-init}"
mkdir -p "$SENDBLUE_HOME"
export HOME="$SENDBLUE_HOME"


npx -y @sendblue/cli@latest sandbox init

```

--------------------------------

### 200 OK response for get webhooks

Source: https://docs.sendblue.com/api/resources/webhooks/methods/list

Example response showing the webhook configuration with event URLs and the global secret.

```json
{
  "status": "OK",
  "webhooks": {
    "call_completed": [
      "https://example.com"
    ],
    "call_log": [
      "https://example.com"
    ],
    "contact_created": [
      "https://example.com"
    ],
    "contact_profile": [
      "https://example.com"
    ],
    "globalSecret": "whsec_global123",
    "inbound_call": [
      "https://example.com"
    ],
    "line_assigned": [
      "https://example.com"
    ],
    "line_blocked": [
      "https://example.com"
    ],
    "outbound": [
      "https://example.com"
    ],
    "receive": [
      "https://example.com"
    ],
    "typing_indicator": [
      "https://example.com"
    ]
  }
}
```

--------------------------------

### Get Contact Count - curl Example

Source: https://docs.sendblue.com/api-v2/contacts

Example curl command to get the contact count. Requires your API key and secret key as headers.

```bash
curl -X GET 'https://api.sendblue.com/api/v2/contacts/count' \
  -H 'sb-api-key-id: YOUR_API_KEY' \
  -H 'sb-api-secret-key: YOUR_API_SECRET'
```

--------------------------------

### 200 example response for GET /api/v2/seats/count

Source: https://docs.sendblue.com/api/resources/v2/subresources/seats/methods/count

Example response showing a count of 12 seats.

```json
{
  "count": 12
}
```

--------------------------------

### GET /api/v2/contacts

Source: https://docs.sendblue.com/api/resources/contacts/methods/list

This snippet documents the GET /api/v2/contacts endpoint, including its query parameters, request example, and response schema.

```APIDOC
## GET /api/v2/contacts

### Description
Retrieve a list of contacts for the authenticated account.

### Method
GET

### Endpoint
/api/v2/contacts

### Parameters
#### Query Parameters
- **cid** (string) - Optional - Filter by contact ID
- **created_at_gte** (string, date-time) - Optional - Filter contacts created at or after this ISO 8601 timestamp (event recovery)
- **limit** (number) - Optional - Maximum number of contacts to return. Defaults to 100, capped at 1000. Minimum: 1, Maximum: 1000.
- **offset** (number) - Optional - Number of contacts to skip. Capped at 10000. Minimum: 0, Maximum: 10000.
- **order_by** (string) - Optional - Field to sort by
- **order_direction** (string) - Optional - Sort direction. One of: "asc", "desc".
- **phone_number** (string) - Optional - Filter by phone number

### Request Example
```
curl https://api.sendblue.co/api/v2/contacts \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET"
```

### Response
#### Success Response (200)
- **assigned_to_email** (string) - Optional - Email of assigned user
- **company_name** (string) - Optional - Company name
- **contact_id** (string) - Optional - Immutable contact identity (included by list responses for event recovery)
- **created_at** (string, date-time) - Optional - When the contact was created
- **custom_variables** (map[string]) - Optional - Custom key-value pairs stored on the contact. Keys are human-readable labels.
- **first_name** (string) - Optional - First name
- **last_name** (string) - Optional - Last name
- **opt_out** (boolean) - Optional - Whether the contact has opted out of SMS (from recipient opt-out state)
- **phone** (string) - Optional - Phone number in E.164 format
- **sendblue_number** (string) - Optional - Associated Sendblue phone number
- **tags** (array of string) - Optional - Tags associated with the contact
- **verified** (boolean) - Optional - Whether the contact is verified

#### Response Example
```
[
  {
    "assigned_to_email": "agent@example.com",
    "company_name": "Example Corp",
    "contact_id": "contact_id",
    "created_at": "2024-01-15T10:30:00Z",
    "custom_variables": {
      "Lead Source": "Website",
      "Plan": "Enterprise"
    },
    "first_name": "John",
    "last_name": "Doe",
    "opt_out": false,
    "phone": "+1234567890",
    "sendblue_number": "+1987654321",
    "tags": [
      "customer",
      "vip"
    ],
    "verified": true
  }
]
```
```

--------------------------------

### Poll setup with --no-wait and create sandbox

Source: https://docs.sendblue.com/sandboxes

Uses `--no-wait` to print instructions and poll later. Sets up the same HOME, runs init with --no-wait, polls `setup --check` until success (exit code 3 means retry), then creates a sandbox.

```bash
export SENDBLUE_HOME="${SENDBLUE_HOME:-${TMPDIR:-/tmp}/sendblue-sandbox-init}"
mkdir -p "$SENDBLUE_HOME"
export HOME="$SENDBLUE_HOME"


npx -y @sendblue/cli@latest sandbox init --no-wait


until npx -y @sendblue/cli@latest setup --check; do
  code=$?
  if [ "$code" -eq 3 ]; then
    sleep 5
  else
    exit "$code"
  fi
done


npx -y @sendblue/cli@latest sandbox create

```

--------------------------------

### Set up environment and poll for setup completion

Source: https://docs.sendblue.com/sandboxes

Use this shell script when you need to print instructions and poll from a later tool call. It sets SENDBLUE_HOME, creates the directory, runs the CLI with --no-wait, and polls until setup is complete. Exit code 3 means the text has not arrived yet.

```bash
export SENDBLUE_HOME="${SENDBLUE_HOME:-${TMPDIR:-/tmp}/sendblue-sandbox-init}"
mkdir -p "$SENDBLUE_HOME"
export HOME="$SENDBLUE_HOME"


npx -y @sendblue/cli@latest sandbox init --no-wait


until npx -y @sendblue/cli@latest setup --check; do
  code=$?
  if [ "$code" -eq 3 ]; then
    sleep 5
  else
    exit "$code"
  fi
done


npx -y @sendblue/cli@latest sandbox create
```

--------------------------------

### 200 response example

Source: https://docs.sendblue.com/api/resources/messages/methods/list

Example of a successful response from the Get messages endpoint. Shows the structure of the returned message objects and pagination details.

```json
{
  "data": [
    {
      "accountEmail": "user@example.com",
      "content": "Hello, World!",
      "date_sent": "2024-01-01T12:00:00Z",
      "date_updated": "2024-01-01T12:00:01Z",
      "error_code": null,
      "error_detail": null,
      "error_key": null,
      "error_message": null,
      "error_reason": null,
      "from_number": "+19998887777",
      "group_display_name": null,
      "group_id": null,
      "is_outbound": true,
      "location": {
        "latitude": 37.7749,
        "longitude": -122.4194,
        "accuracy": 12,
        "altitude": 8,
        "duration": "oneHour",
        "timestamp": "2026-06-23T12:00:00.000Z"
      },
      "media_url": null,
      "message_handle": "msg_abc123def456",
      "message_type": "message",
      "number": "+18887776666",
      "opted_out": false,
      "participants": [
        "string"
      ],
      "plan": "premium",
      "reply_to": {
        "message_handle": "msg_parent123",
        "part_index": 0
      },
      "seat_id": "550e8400-e29b-41d4-a716-446655440000",
      "send_style": "celebration",
      "sendblue_number": "+19998887777",
      "sender_email": "rep@example.com",
      "service": "iMessage",
      "status": "SENT",
      "thread_originator": {
        "message_handle": "msg_root456",
        "part": "0:0"
      },
      "to_number": "+18887776666",
      "was_downgraded": false
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 50,
    "offset": 0,
    "total": 1000
  },
  "status": "OK"
}
```

--------------------------------

### 200 example response for get contacts

Source: https://docs.sendblue.com/api/resources/contacts/methods/list

Example JSON response returned by the API when the request succeeds. Shows the structure of a contact object.

```json
[
  {
    "assigned_to_email": "agent@example.com",
    "company_name": "Example Corp",
    "contact_id": "contact_id",
    "created_at": "2024-01-15T10:30:00Z",
    "custom_variables": {
      "Lead Source": "Website",
      "Plan": "Enterprise"
    },
    "first_name": "John",
    "last_name": "Doe",
    "opt_out": false,
    "phone": "+1234567890",
    "sendblue_number": "+1987654321",
    "tags": [
      "customer",
      "vip"
    ],
    "verified": true
  }
]
```

--------------------------------

### Connect to Sendblue sandbox after setup

Source: https://docs.sendblue.com/llms.txt

Run this command after the setup text has been sent and the CLI has saved keys and created the first sandbox. It continues the sandbox setup process.

```bash
npx -y @sendblue/cli@latest sandbox connect
```

--------------------------------

### TextMe install

Source: https://docs.sendblue.com/getting-started

Clones the TextMe repository and builds the daemon.

```bash
git clone https://github.com/njerschow/textme.git
cd textme/daemon && npm install && npm run build
```

--------------------------------

### 200 response example

Source: https://docs.sendblue.com/api/resources/v2/subresources/seats/methods/retrieve

Example 200 response for the Get a seat endpoint. Shows the seat object with account, timestamps, contact details, and status.

```json
{
  "seat": {
    "account": "acmeco",
    "created_at": "2024-06-15T18:24:01Z",
    "email": "rep@example.com",
    "first_name": "Jane",
    "forwarding_number": "+19998887777",
    "last_name": "Doe",
    "seat_id": "550e8400-e29b-41d4-a716-446655440000"
  },
  "status": "OK"
}
```

--------------------------------

### Email-based setup with npx @sendblue/cli setup

Source: https://docs.sendblue.com/getting-started/quickstart

Two-step email flow: first command prompts for email and sends an 8-digit verification code; second command completes setup with the code, company name, and contact. Use the --code flag with the verification code from your inbox.

```bash
npx -y @sendblue/cli setup --email you@example.com
# Check your inbox, then provide the 8-digit verification code.
npx -y @sendblue/cli setup --email you@example.com --code 12345678 --company my-agent --contact +15551234567

```

--------------------------------

### Get Single Seat - Example Request (curl)

Source: https://docs.sendblue.com/api-v2/seats

Example curl request to retrieve a single seat by its UUID. Requires sb-api-key-id and sb-api-secret-key headers.

```bash
curl -X GET 'https://api.sendblue.com/api/v2/seats/550e8400-e29b-41d4-a716-446655440000' \
  -H 'sb-api-key-id: YOUR_API_KEY' \
  -H 'sb-api-secret-key: YOUR_API_SECRET'
```

--------------------------------

### Get Single Contact - curl Example

Source: https://docs.sendblue.com/api-v2/contacts

Example curl command to retrieve a single contact. Requires your API key and secret key as headers.

```bash
curl -X GET 'https://api.sendblue.com/api/v2/contacts/%2B14155551234' \
  -H 'sb-api-key-id: YOUR_API_KEY' \
  -H 'sb-api-secret-key: YOUR_API_SECRET'
```

--------------------------------

### Get Message Status - 200 Response Example

Source: https://docs.sendblue.com/api/resources/messages/methods/get_status

Example JSON response returned on success, containing message details such as status, content, and metadata.

```json
{
  "account_email": "user@example.com",
  "app_card": {
    "appName": "My App",
    "extensionBundleId": "com.example.myapp.MessagesExtension",
    "layout": {
      "caption": "Check this out",
      "imageSubtitle": "imageSubtitle",
      "imageTitle": "imageTitle",
      "imageUrl": "https://example.com",
      "subcaption": "Tap to open",
      "summary": "summary",
      "trailingCaption": "trailingCaption",
      "trailingSubcaption": "trailingSubcaption"
    },
    "teamId": "ABCDE12345",
    "url": "https://example.com/deep-link",
    "appStoreId": 1234567890,
    "fallbackText": "fallbackText",
    "interactive": true,
    "sessionIdentifier": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "updateMessageHandle": "updateMessageHandle"
  },
  "content": "Hello, World!",
  "date_created": "2023-10-01T12:00:00Z",
  "date_updated": "2023-10-01T12:00:01Z",
  "error_code": 0,
  "error_key": null,
  "error_message": "error_message",
  "from_number": "+19998887777",
  "is_outbound": true,
  "location": {
    "latitude": 37.7749,
    "longitude": -122.4194,
    "accuracy": 12,
    "altitude": 8,
    "duration": "oneHour",
    "timestamp": "2026-06-23T12:00:00.000Z"
  },
  "media_url": "https://cdn.sendblue.co/media/abc123.jpg",
  "message_handle": "msg_abc123def456",
  "message_type": "message",
  "number": "+18887776666",
  "reply_to": {
    "message_handle": "msg_parent123",
    "part_index": 0
  },
  "seat_id": "550e8400-e29b-41d4-a716-446655440000",
  "send_style": "celebration",
  "sender_email": "rep@example.com",
  "status": "QUEUED",
  "thread_originator": {
    "message_handle": "msg_root456",
    "part": "0:0"
  }
}
```

--------------------------------

### Set up account with phone verification

Source: https://docs.sendblue.com/getting-started/credentials

Creates a new account using phone verification. The phone number becomes the login identity and an internal email is generated.

```bash
sendblue setup --phone +15551234567 --company my-agent
```

--------------------------------

### Enable Auto Typing Indicator - Node.js Example

Source: https://docs.sendblue.com/api-v2/typing-indicators

Node.js example using axios to enable the auto typing indicator. Requires axios to be installed.

```javascript
const axios = require('axios');


await axios.post(
  'https://api.sendblue.com/accounts/settings/auto-typing-indicator',
  { auto_typing_indicator: true },
  {
    headers: {
      'sb-api-key-id': 'YOUR_API_KEY',
      'sb-api-secret-key': 'YOUR_API_SECRET',
      'Content-Type': 'application/json'
    }
  }
);
```

--------------------------------

### Non-interactive sandbox setup with environment isolation

Source: https://docs.sendblue.com/llms.txt

Sets up a sandbox non-interactively by isolating credentials in a temporary home directory. Exports SENDBLUE_HOME and HOME to a deterministic path, runs sandbox init with --no-wait, polls with setup --check until exit code 3 is no longer returned, then shows keys and creates a sandbox. Repeat the exports before polling if in a later shell.

```bash
# Keep signup credentials isolated from any existing Sendblue login on this machine.
# Use a deterministic path so later shell/tool calls keep the pending verification state.
export SENDBLUE_HOME="${SENDBLUE_HOME:-${TMPDIR:-/tmp}/sendblue-sandbox-init}"
mkdir -p "$SENDBLUE_HOME"
export HOME="$SENDBLUE_HOME"

# Start signup and relay the shown text instructions to the human.
npx -y @sendblue/cli@latest sandbox init --no-wait

# Repeat these exports before polling if this is a later shell/tool call.
export SENDBLUE_HOME="${SENDBLUE_HOME:-${TMPDIR:-/tmp}/sendblue-sandbox-init}"
mkdir -p "$SENDBLUE_HOME"
export HOME="$SENDBLUE_HOME"

# Poll until the human texts the challenge. Exit code 3 means still waiting.
until npx -y @sendblue/cli@latest setup --check; do
  code=$?
  if [ "$code" -eq 3 ]; then sleep 5; else exit "$code"; fi
done

npx -y @sendblue/cli@latest show-keys
npx -y @sendblue/cli@latest sandbox create
```

--------------------------------

### Set up Sendblue CLI and retrieve credentials

Source: https://docs.sendblue.com/guides/chat-sdk-adapter

Installs the Sendblue CLI globally and runs commands to set up credentials, show API keys, and list assigned Sendblue numbers. Use these commands to find your API credentials and assigned numbers.

```bash
npm install -g @sendblue/cli
sendblue setup
sendblue show-keys
sendblue lines
```

--------------------------------

### Get Current TOTP Code - Example Request (curl)

Source: https://docs.sendblue.com/api-v2/totp

Example curl command to fetch the current TOTP code. Replace YOUR_API_KEY and YOUR_API_SECRET with your credentials.

```bash
curl 'https://api.sendblue.com/api/v2/totp/code/550e8400-e29b-41d4-a716-446655440000' \
  -H 'sb-api-key-id: YOUR_API_KEY' \
  -H 'sb-api-secret-key: YOUR_API_SECRET'
```

--------------------------------

### Basic Webhook Setup (POST /api/account/webhooks)

Source: https://docs.sendblue.com/getting-started/webhooks

Creates a webhook for receiving messages. Uses the POST method with the sb-api-key-id and sb-api-secret-key headers. The webhooks array contains the URL to receive events. The response is logged to the console.

```javascript
// Add a simple webhook for receiving messages
const response = await fetch("https://api.sendblue.com/api/account/webhooks", {
  method: "POST",
  headers: {
    "sb-api-key-id": "YOUR_API_KEY",
    "sb-api-secret-key": "YOUR_API_SECRET",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    webhooks: ["https://myapp.com/webhooks/sendblue"],
    type: "receive",
  }),
});


const data = await response.json();
console.log(data);
```

--------------------------------

### 200 example response for get group membership

Source: https://docs.sendblue.com/api/resources/v2/subresources/groups/methods/retrieve

Example 200 response showing the group membership data structure, including participants and group photo metadata.

```json
{
  "data": {
    "created_at": "2026-07-22T07:46:50.063Z",
    "group_id": "sb_group_608acc54-d0d7-4b41-8092-9ff6e1e70455",
    "group_name": "+15167251294, +13472604672, +12138578327",
    "group_photo": {
      "photo_guid": "AAAAAAAA-1111-2222-3333-444444444444",
      "url": "https://storage.googleapis.com/..."
    },
    "latest_comm_at": "2026-07-22T07:46:50.455Z",
    "latest_message_id": "FFEBE7AA-C6DF-4645-ACDB-CF796AA94C5E",
    "participant_numbers": [
      "+15167251294",
      "+13472604672",
      "+12138578327"
    ],
    "participants": [
      {
        "contact_id": "b76884a0-91ae-4568-a96d-a0d36e389276",
        "handle": "+15167251294",
        "name": "Jane Doe",
        "participant_id": "28460d34-8867-4c97-abf3-bb3b6a1fdd6f",
        "phone": "+15167251294",
        "seat_id": null,
        "type": "contact"
      }
    ],
    "updated_at": "2026-07-22T07:46:50.170Z",
    "worker_group_id": "82F8AE6E-ED4F-4FEA-83D3-AF3786E6186E"
  },
  "status": "OK"
}
```

--------------------------------

### Start TextMe daemon

Source: https://docs.sendblue.com/getting-started/quickstart

Starts the TextMe daemon after configuration.

```bash
npm start

```

--------------------------------

### Example request - curl

Source: https://docs.sendblue.com/calling/facetime

Example curl command to start a FaceTime call. Uses your API key and secret in headers, and sends phoneNumber and fromNumber in the JSON body.

```bash
curl -X POST 'https://api.sendblue.com/facetime/start-call' \
  -H 'sb-api-key-id: YOUR_API_KEY' \
  -H 'sb-api-secret-key: YOUR_API_SECRET' \
  -H 'Content-Type: application/json' \
  -d '{
    "phoneNumber": "+14155550123",
    "fromNumber": "+18885550199"
  }'
```

--------------------------------

### 200 example response for get verified contact

Source: https://docs.sendblue.com/api/resources/verified_contacts/methods/retrieve

Example JSON response returned when the request succeeds. Shows a contact with verification_status 'pending' and verified false, along with the shared line.

```json
{
  "data": {
    "contact": {
      "created_at": "2026-08-12T18:32:12.000Z",
      "phone_number": "+12125550199",
      "updated_at": "2026-08-12T18:32:12.000Z",
      "verification_status": "pending",
      "verified": false
    },
    "line": {
      "phone_number": "+12125550101",
      "type": "shared"
    }
  }
}
```

--------------------------------

### Install Chat SDK and Sendblue adapter

Source: https://docs.sendblue.com/guides/chat-sdk-adapter

Installs the Chat SDK, the Sendblue adapter, and an in-memory state adapter for local development. For production, use a persistent state adapter such as @chat-adapter/state-redis instead of in-memory state.

```bash
npm install chat chat-adapter-sendblue @chat-adapter/state-memory
```

--------------------------------

### Get one contact's location - curl request

Source: https://docs.sendblue.com/api-v2/location-sharing

Example curl command to get a single contact's location. Replace `YOUR_API_KEY` and `YOUR_API_SECRET` with your credentials. The `{number}` is URL-encoded.

```bash
curl -X GET 'https://api.sendblue.com/api/location/%2B19175551234?from_number=%2B14155559876' \
  -H 'sb-api-key-id: YOUR_API_KEY' \
  -H 'sb-api-secret-key: YOUR_API_SECRET'
```

--------------------------------

### Email-based setup with verification code

Source: https://docs.sendblue.com/llms.txt

Performs email-based account setup. Requires SENDBLUE_EMAIL, then asks for an 8-digit email verification code, a unique lowercase company name, and the user's mobile E.164 number. Runs setup twice: first to initiate, then with the code and details.

```bash
SENDBLUE_EMAIL="${SENDBLUE_EMAIL:?set SENDBLUE_EMAIL to the user email address}"
npx -y @sendblue/cli@latest setup --email "$SENDBLUE_EMAIL"
# Ask the user for the 8-digit email verification code.
SENDBLUE_EMAIL_CODE="${SENDBLUE_EMAIL_CODE:?ask the user for the 8-digit email verification code}"
SENDBLUE_COMPANY="${SENDBLUE_COMPANY:?ask the user for a unique lowercase account name}"
USER_MOBILE_E164="${USER_MOBILE_E164:?set USER_MOBILE_E164 to the user mobile E.164 number}"
npx -y @sendblue/cli@latest setup --email "$SENDBLUE_EMAIL" --code "$SENDBLUE_EMAIL_CODE" --company "$SENDBLUE_COMPANY" --contact "$USER_MOBILE_E164"
```

--------------------------------

### Get Current TOTP Code - Success Response (200)

Source: https://docs.sendblue.com/api-v2/totp

Example 200 response for the get current TOTP code endpoint. The expires_in field indicates seconds remaining in the current time window.

```json
{
  "status": "OK",
  "code": "482031",
  "expires_in": 14
}
```

--------------------------------

### Create a sandbox: POST /v3/sandboxes

Source: https://docs.sendblue.com/sandboxes

Creates a new sandbox. Returns 201 once booted (typically a few seconds); the returned id is immediately usable for exec without polling.

```http
POST https://api.sendblue.com/v3/sandboxes
```

```bash
curl -X POST 'https://api.sendblue.com/v3/sandboxes' \
  -H 'sb-api-key-id: YOUR_API_KEY_ID' \
  -H 'sb-api-secret-key: YOUR_API_SECRET_KEY'
```

```json
{
  "data": {
    "id": "sbx_a9c7253d-8567-4fff-bf81-08a25076e50f",
    "object": "sandbox",
    "status": "running",
    "created_at": "2026-07-19T18:03:14.399Z"
  }
}
```

--------------------------------

### Get Single Seat - Error Response (404)

Source: https://docs.sendblue.com/api-v2/seats

Example JSON error response when the seat is not found.

```json
{ "status": "ERROR", "message": "Seat not found" }
```

--------------------------------

### POST /v3/sandboxes

Source: https://docs.sendblue.com/sandboxes

Creates a new sandbox. Returns 201 once the sandbox has booted, and the sandbox ID is immediately usable for exec.

```APIDOC
## POST /v3/sandboxes

### Description
Creates a new sandbox. Returns 201 once the sandbox has actually booted (typically a few seconds) — the `id` is immediately usable for `exec`, no polling needed.

### Method
POST

### Endpoint
https://api.sendblue.com/v3/sandboxes

### Parameters
#### Headers
- **sb-api-key-id** (string) - Required - Your API key ID
- **sb-api-secret-key** (string) - Required - Your API secret key

### Request Example
```
curl -X POST 'https://api.sendblue.com/v3/sandboxes' \
  -H 'sb-api-key-id: YOUR_API_KEY_ID' \
  -H 'sb-api-secret-key: YOUR_API_SECRET_KEY'
```

### Response
#### Success Response (201)
- **data.id** (string) - Sandbox ID
- **data.object** (string) - Always "sandbox"
- **data.status** (string) - Status of the sandbox (e.g., "running")
- **data.created_at** (string) - Creation timestamp

#### Response Example
```
{
  "data": {
    "id": "sbx_a9c7253d-8567-4fff-bf81-08a25076e50f",
    "object": "sandbox",
    "status": "running",
    "created_at": "2026-07-19T18:03:14.399Z"
  }
}
```
```

--------------------------------

### Install Sendblue MCP server via npx

Source: https://docs.sendblue.com/mcp

Run these commands in your terminal to install and launch the Sendblue MCP server. Set SENDBLUE_API_API_KEY and SENDBLUE_API_API_SECRET first; credentials are available in the Sendblue dashboard or via `sendblue show-keys`.

```bash
export SENDBLUE_API_API_KEY="your-api-key"
export SENDBLUE_API_API_SECRET="your-api-secret"
npx -y sendblue-api-mcp@latest
```
Tokens:
Raw