Contacts
Create, list, and manage the WhatsApp contacts in your organization. Contacts carry custom metadata and tags you can use to segment audiences.
/v1/contacts Create contact
Create a new contact in your organization's address book.
Parameters
phone_number string required Contact phone number in E.164 format (e.g. +1234567890).
name string Display name for the contact.
metadata object Custom key-value attributes attached to the contact.
Request
curl -X POST https://api.boltly.online/v1/contacts \
-H "X-API-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"phone_number": "+1234567890",
"name": "Jane Doe",
"metadata": { "plan": "pro" }
}'Response
{
"data": {
"id": "c1a2b3c4-...",
"organization_id": "org_01H...",
"phone_number": "+1234567890",
"name": "Jane Doe",
"tags": [],
"metadata": { "plan": "pro" },
"created_at": "2026-04-03T12:00:00Z",
"updated_at": "2026-04-03T12:00:00Z"
}
}/v1/contacts List contacts
Retrieve a paginated list of contacts, optionally filtered by a search term.
Parameters
search string Search by name or phone number.
page integer Page number. Defaults to 1.
per_page integer Results per page. Defaults to 20, max 100.
Request
curl https://api.boltly.online/v1/contacts?search=jane \
-H "X-API-Key: $API_KEY"Response
{
"data": [
{
"id": "c1a2b3c4-...",
"phone_number": "+1234567890",
"name": "Jane Doe",
"tags": ["vip"],
"created_at": "2026-04-03T12:00:00Z",
"updated_at": "2026-04-03T12:00:00Z"
}
],
"meta": { "page": 1, "per_page": 20, "total": 87 }
}/v1/contacts/{id} Get contact
Retrieve a single contact by its ID.
Parameters
id string required Contact ID.
Request
curl https://api.boltly.online/v1/contacts/c1a2b3c4-... \
-H "X-API-Key: $API_KEY"Response
{
"data": {
"id": "c1a2b3c4-...",
"organization_id": "org_01H...",
"phone_number": "+1234567890",
"name": "Jane Doe",
"tags": ["vip"],
"metadata": { "plan": "pro" },
"created_at": "2026-04-03T12:00:00Z",
"updated_at": "2026-04-03T12:00:00Z"
}
}/v1/contacts/{id} Update contact
Update a contact's name or metadata. Only provided fields are changed.
Parameters
id string required Contact ID.
name string New display name for the contact.
metadata object Custom key-value attributes. Replaces existing metadata when provided.
Request
curl -X PUT https://api.boltly.online/v1/contacts/c1a2b3c4-... \
-H "X-API-Key: $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Jane Smith",
"metadata": { "plan": "enterprise" }
}'Response
{
"data": {
"id": "c1a2b3c4-...",
"phone_number": "+1234567890",
"name": "Jane Smith",
"tags": ["vip"],
"metadata": { "plan": "enterprise" },
"created_at": "2026-04-03T12:00:00Z",
"updated_at": "2026-04-05T09:30:00Z"
}
}/v1/contacts/{id} Delete contact
Permanently delete a contact from your organization.
Parameters
id string required Contact ID.
Request
curl -X DELETE https://api.boltly.online/v1/contacts/c1a2b3c4-... \
-H "X-API-Key: $API_KEY"Response
{
"data": {
"id": "c1a2b3c4-...",
"deleted": true
}
}