Get an invitation

GET/v1/invitations/{inv}

Retrieves an invitation’s status: delivery, the customer’s response, and the chat it opened. Unknown ids, and another brand’s; return HTTP 404.

Path ParametersExpand Collapse

inv: string

ReturnsExpand Collapse

id: string

Invitation id (inv_…).

chat_id: string

created_at: string

formatdate-time

delivery: string

The underlying message’s delivery state; same values as GET /v1/messages/{msg}.

opted_out: boolean

Derived from the consent record: a later tel STOP flips it. Independent of response.

parameters: unknown

The parameters as sent (JSON null when none).

reference_id: string

response: string

none, accepted, declined, or superseded (an outstanding card on a thread a sibling’s accept superseded).

response_source: string

How response was resolved: tap; Apple forwarded the customer’s own interaction and we correlated it by the card’s requestIdentifier; inference; we concluded it from message ordering (a reply on the thread while the card was outstanding), which a later tap may correct; none; unresolved, and for the derived superseded response, which is a fact about the chat rather than an answer from the customer.

Reconcile on this when a deduced decline must not be treated like an answered one.

template_id: string

accepted_chat_id: optional string

The opaque chat the customer landed in; this card’s accept, or the sibling accept that superseded it.

locale: optional string

Omitted when the send carried none.

Get an invitation

curl https://messages.api.linqapp.com/v1/invitations/$INV \
    -H "Authorization: Bearer $LINQ_AMB_API_KEY"

{
  "id": "inv_6b2e04",
  "chat_id": "chat_4f81b2",
  "template_id": "invt_a4f2c718d0",
  "reference_id": "ride-88214",
  "locale": "en-US",
  "parameters": {
    "brandName": "Acme Rides"
  },
  "delivery": "sent",
  "response": "accepted",
  "response_source": "customer",
  "accepted_chat_id": "chat_4f81b2",
  "opted_out": false,
  "created_at": "2026-08-06T13:58:02Z"
}

Returns Examples

{
  "id": "inv_6b2e04",
  "chat_id": "chat_4f81b2",
  "template_id": "invt_a4f2c718d0",
  "reference_id": "ride-88214",
  "locale": "en-US",
  "parameters": {
    "brandName": "Acme Rides"
  },
  "delivery": "sent",
  "response": "accepted",
  "response_source": "customer",
  "accepted_chat_id": "chat_4f81b2",
  "opted_out": false,
  "created_at": "2026-08-06T13:58:02Z"
}