Skip to content
V2 (Legacy) API ReferenceGet started

Update contact card

PATCH/v3/contact_card

Partially updates an existing active contact card for a phone number.

Fetches the current active contact card and merges the provided fields. Only fields present in the request body are updated; omitted fields retain their existing values.

Requires an active contact card to exist for the phone number.

Query ParametersExpand Collapse
phone_number: string

E.164 phone number of the contact card to update

Body ParametersJSONExpand Collapse
first_name: optional string

Updated first name. If omitted, the existing value is kept.

image_url: optional string

Updated profile image URL. If omitted, the existing image is kept.

last_name: optional string

Updated last name. If omitted, the existing value is kept.

ReturnsExpand Collapse
SetContactCard object { first_name, is_active, phone_number, 2 more }
first_name: string

First name on the contact card

is_active: boolean

Whether the contact card was successfully applied to the device

phone_number: string

The phone number the contact card is associated with

image_url: optional string

Image URL on the contact card

last_name: optional string

Last name on the contact card

Update contact card

curl https://api.linqapp.com/api/partner/v3/contact_card \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $LINQ_API_V3_API_KEY" \
    -d '{
          "first_name": "John",
          "image_url": "https://cdn.linqapp.com/contact-card/example.jpg",
          "last_name": "Doe"
        }'
{
  "phone_number": "+15551234567",
  "first_name": "John",
  "last_name": "Doe",
  "image_url": "https://cdn.linqapp.com/contact-card/example.jpg",
  "is_active": true
}
{
  "error": {
    "status": 400,
    "code": 1002,
    "message": "Phone number must be in E.164 format"
  },
  "success": false
}
{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token"
  },
  "success": false
}
{
  "error": {
    "status": 403,
    "code": 2005,
    "message": "Access denied - insufficient permissions for this resource"
  },
  "success": false
}
{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found"
  },
  "success": false
}
{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error"
  },
  "success": false
}
{
  "error": {
    "status": 503,
    "code": 4004,
    "message": "RCS capability check is temporarily unavailable."
  },
  "success": false
}
Returns Examples
{
  "phone_number": "+15551234567",
  "first_name": "John",
  "last_name": "Doe",
  "image_url": "https://cdn.linqapp.com/contact-card/example.jpg",
  "is_active": true
}
{
  "error": {
    "status": 400,
    "code": 1002,
    "message": "Phone number must be in E.164 format"
  },
  "success": false
}
{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token"
  },
  "success": false
}
{
  "error": {
    "status": 403,
    "code": 2005,
    "message": "Access denied - insufficient permissions for this resource"
  },
  "success": false
}
{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found"
  },
  "success": false
}
{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error"
  },
  "success": false
}
{
  "error": {
    "status": 503,
    "code": 4004,
    "message": "RCS capability check is temporarily unavailable."
  },
  "success": false
}