Update contact

PUT https://app.sendapp.ai/api/contacts/{id}

Update one or more fields of a contact. Only the keys you send are changed; tags REPLACES the whole set (use the tag endpoints to add or remove single tags). Every change is written to the contact timeline. PATCH is accepted too.

Parameters

10 · 2 required

apikey required

Your API Key (the X-API-Key header also works).

id required

Contact ID (integer, in the path). Use GET /api/contacts to find it.

name optional

Contact name.

phone optional

Phone number in international format. 409 if it already belongs to another contact.

email optional

Email address. 409 if it already belongs to another contact.

birthday optional

Date in YYYY-MM-DD format (null to clear).

tags optional

Array or comma-separated string — replaces all tags.

custom_fields optional

Object keyed by custom field NAME, e.g. {"City": "Rome"}. Unknown names return 422. Send null or "" to clear a value.

opted_out optional

true = exclude from campaigns, false = re-subscribe.

lifecycle_stage optional

One of lead, qualified, customer, inactive, lost (null to clear).

Need help with the integration? info@sendapp.live

Request

curl -X PUT 'https://app.sendapp.ai/api/contacts/42' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Mario Rossi", "tags": ["cliente", "vip"], "custom_fields": { "City": "Milano" }, "lifecycle_stage": "customer" }'

<?php
$ch = curl_init('https://app.sendapp.ai/api/contacts/42');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => ['X-API-Key: YOUR_API_KEY', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['name' => 'Mario Rossi', 'tags' => ['cliente', 'vip'], 'custom_fields' => ['City' => 'Milano'], 'lifecycle_stage' => 'customer']),
]);
echo curl_exec($ch);
curl_close($ch);

const res = await fetch('https://app.sendapp.ai/api/contacts/42', {
  method: 'PUT',
  headers: { 'X-API-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ name: 'Mario Rossi', tags: ['cliente', 'vip'], custom_fields: { City: 'Milano' }, lifecycle_stage: 'customer' })
});
console.log(await res.json());

Response

{
  "status": "success",
  "changed": ["name", "tags", "custom_fields", "lifecycle_stage"],
  "contact": { "id": 42, "name": "Mario Rossi", "tags": ["cliente", "vip"], "lifecycle_stage": "customer", "...": "..." }
}

{
  "status": "error",
  "message": "Unknown custom field(s): Citta",
  "unknown_fields": ["Citta"]
}