Engagive API documentation

Channels · WhatsApp · Contacts

Contact APIs

Base URL & auth

  • Prefix: /api/business/public on https://api.engagive.io (full base: https://api.engagive.io/api/business/public).
  • Header: Authorization: Bearer <token> — create the token under Profile → API access token in the business app.
  • See also: Authentication, Errors & responses.

Manage WhatsApp contacts for an account. Phone number is stored as digits; country_code includes `+` (e.g. `+92`). Soft-deleted contacts can be restored by creating the same number again.

GET

List contacts

Required permission: WhatsApp Contacts — View

Paginated contacts for the account. Optional search filters name/number.

Path
/api/business/public/channels/whatsapp/accounts/:accountId/contacts
Example success response (JSON)
{
  "success": true,
  "statusCode": 200,
  "data": [
    {
      "id": 42,
      "first_name": "Ali",
      "middle_name": null,
      "last_name": "Khan",
      "meta_name": null,
      "number": "923001234567",
      "country_code": "+92",
      "wa_phone_id": "923001234567",
      "created_at": "2026-08-01T10:00:00.000Z",
      "created_by": "owner",
      "updated_at": "2026-08-01T10:00:00.000Z",
      "updated_by": "owner",
      "ai_mode": "ai_paused",
      "tags": []
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 10,
    "totalCount": 1,
    "totalPages": 1
  }
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
GET https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/contacts?page=1&pageSize=10
GET

Get contact

Required permission: WhatsApp Contacts — View

Path
/api/business/public/channels/whatsapp/accounts/:accountId/contacts/:contactId
Example success response (JSON)
{
  "success": true,
  "statusCode": 200,
  "data": {
    "id": 42,
    "ref_id": null,
    "first_name": "Ali",
    "middle_name": null,
    "last_name": "Khan",
    "meta_name": null,
    "number": "923001234567",
    "country_code": "+92",
    "wa_phone_id": "923001234567",
    "created_at": "2026-08-01T10:00:00.000Z",
    "created_by": "owner",
    "updated_at": "2026-08-01T10:00:00.000Z",
    "updated_by": "owner",
    "ai_mode": "ai_paused",
    "tags": []
  }
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
GET https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/contacts/42
POST

Create contact

Required permission: WhatsApp Contacts — Add

number and country_code required. name is optional (split into first/middle/last). Duplicate active numbers return 409.

Path
/api/business/public/channels/whatsapp/accounts/:accountId/contacts
Example request body (JSON)
{
  "name": "Ali Khan",
  "number": "3001234567",
  "country_code": "+92"
}
Example success response (JSON)
{
  "success": true,
  "statusCode": 201,
  "message": "Contact created successfully",
  "data": {
    "id": 42
  }
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
POST https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/contacts
PUT

Update contact

Required permission: WhatsApp Contacts — Edit

Path
/api/business/public/channels/whatsapp/accounts/:accountId/contacts/:contactId
Example request body (JSON)
{
  "name": "Ali Khan",
  "number": "3001234567",
  "country_code": "+92"
}
Example success response (JSON)
{
  "success": true,
  "statusCode": 201,
  "message": "Contact created successfully",
  "data": {
    "id": 42
  }
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
PUT https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/contacts/42
DELETE

Delete contact

Required permission: WhatsApp Contacts — Delete

Soft-deletes the contact (sets inactive).

Path
/api/business/public/channels/whatsapp/accounts/:accountId/contacts/:contactId
Example success response (JSON)
{
  "success": true,
  "message": "Contact deleted successfully",
  "data": null
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
DELETE https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/contacts/42