Contact Card

Setup contact card

Creates a contact card for a phone number. This endpoint is intended for initial, one-time setup only.

If setup does not complete, the response is 500 (2022) — call this endpoint again.

If the upstream write is rate-limited, the response is 503 (4004) instead. Setup did not complete and the card is not active — wait before retrying, because repeated attempts extend the rate limit.

Note: once a card is active, this endpoint returns 409 (2014) so an existing card is never overwritten by accident. Use PATCH /v3/contact_card to change it.

Rate limited per phone number: POST and PATCH share a budget of 3 calls every 10 minutes. Further calls return 429, with Retry-After carrying the wait.

post/v3/contact_card

Request

  • Base URL: https://api.linqapp.com/api/partner
  • URL: https://api.linqapp.com/api/partner/v3/contact_card
  • Auth: HTTP bearer

Request body

phone_numberstring required

E.164 phone number to associate the contact card with

first_namestring required

First name for the contact card. Required.

last_namestring

Last name for the contact card. Optional.

image_urlstring

Profile image URL for the contact card.

Example request

{
  "phone_number": "+15551234567",
  "first_name": "John",
  "last_name": "Doe",
  "image_url": "https://cdn.linqapp.com/contact-card/example.jpg"
}

Response

Contact card created/updated and sync attempted

phone_numberstring required

The phone number the contact card is associated with

first_namestring required

First name on the contact card

last_namestring

Last name on the contact card

image_urlstring

Image URL on the contact card

is_activeboolean required

Whether the contact card was successfully applied to the device

Example response

{
  "phone_number": "+15551234567",
  "first_name": "John",
  "last_name": "Doe",
  "image_url": "https://cdn.linqapp.com/contact-card/example.jpg",
  "is_active": true
}

Changes

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