API Reference

Request Location

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Request a contact's location

POST/api/request-location

Send a Find My location request to an iMessage recipient from a supported Sendblue line. The request is queued like a normal outbound iMessage. If the recipient accepts and shares, the location is delivered later as an inbound message_type: location webhook.

Body ParametersJSONExpand Collapse

from_number: string

Your supported Sendblue number in E.164 format

number: string

Recipient phone number in E.164 format

ReturnsExpand Collapse

message: optional string

message_handle: optional string

Unique identifier for tracking the request message

number: optional string

Recipient phone number

status: optional "QUEUED"

uuid: optional string

Unique identifier for tracking the request message

Request a contact's location

HTTP

HTTP

TypeScript

Python

curl https://api.sendblue.co/api/request-location \
    -H 'Content-Type: application/json' \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET" \
    -d '{
          "from_number": "+18887776666",
          "number": "+19998887777"
        }'

200 example

{
  "message": "Location request accepted for dispatch",
  "message_handle": "msg_abc123def456",
  "number": "+19998887777",
  "status": "QUEUED",
  "uuid": "msg_abc123def456"
}

Returns Examples

200 example

{
  "message": "Location request accepted for dispatch",
  "message_handle": "msg_abc123def456",
  "number": "+19998887777",
  "status": "QUEUED",
  "uuid": "msg_abc123def456"
}