Location Sharing

Request location sharing

Request a contact in a chat to share their location. They receive an iMessage prompt and must accept before any location is available; once they do, read their location coordinates with GET /v3/chats/{chatId}/location.

The request is delivered asynchronously. The endpoint returns immediately with { "success": true, "message": "Location request sent" } and does not return coordinates.

Rejected with 409 if the recipient is already sharing — read their location with GET /v3/chats/{chatId}/location instead of re-requesting.

Rate limited per chat, since each request prompts the recipient's device. Exceeding it returns 429 with a Retry-After header.

Location requests only work in 1:1 iMessage chats (Apple limitation):

  • Group chats (any service) return 409 with code 2016 (GroupChatNotSupported).
  • 1:1 SMS and RCS chats return 409 with code 2017 (ChatServiceNotSupported).
post/v3/chats/{chatId}/location/request

Request

  • Base URL: https://api.linqapp.com/api/partner
  • URL: https://api.linqapp.com/api/partner/v3/chats/{chatId}/location/request
  • Auth: HTTP bearer

Path parameters

chatIdstring uuid required

The chat ID to request location from

Response

Location request sent

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "Location request sent"
}

Changes

No recorded changes to this operation across all 1 revision of this API.