---
title: "Add Contact"
method: POST
path: "/api/v1/addContact/{whatsappNumber}"
tags: ["Contacts"]
---

# Add Contact

`POST /api/v1/addContact/{whatsappNumber}`

## Path parameters

- `whatsappNumber` string, required

## Request body

- NewContactModel
  - `name` string, nullable
  - `customParams` CustomParam[], nullable
    - `name` string, nullable
    - `value` string, nullable

## Response `200`

Add contact success

- object
  - `result` boolean — Indicates whether the contact was created successfully.
  - `contact` object — The created or updated contact record.
    - `id` string — Internal contact ID.
    - `wAid` string — WhatsApp ID (phone number) of the contact.
    - `firstName` string — First name of the contact.
    - `fullName` string — Full name of the contact.
    - `phone` string — Phone number of the contact.
    - `source` unknown
    - `contactStatus` string — Validation status of the contact (e.g. VALID, INVALID).
    - `photo` unknown
    - `created` string — Creation date of the contact record.
    - `tags` unknown
    - `customParams` object[] — Custom parameters stored for this contact (name/value pairs).
      - `name` string — Custom parameter name.
      - `value` string — Custom parameter value.
    - `optedIn` boolean — Whether the contact has opted in to receive messages.
    - `isDeleted` boolean — Whether the contact has been soft-deleted.
    - `lastUpdated` string — Last updated timestamp for this contact.
    - `allowBroadcast` boolean — Whether the contact can receive broadcast messages.
    - `allowSMS` boolean — Whether the contact can receive SMS messages.
    - `isInFlow` boolean — Whether the contact is currently in a flow/automation.
    - `lastFlowId` string — ID of the last flow the contact participated in.
    - `currentFlowNodeId` string — ID of the current node in the active flow, if any.

---

[API](https://skmtc.dev/wati/apis/api-documentation-v3.md) · [All operations](https://skmtc.dev/wati/apis/api-documentation-v3/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/wati/api-documentation-v3/revisions/dee16d2c7d41/schema)
