POST

Create Contact

Adds a new individual contact record to your address book.

HTTP Endpoint

POSThttps://api-wa.hidessh.com/api/v1/contacts

Authentication

This endpoint requires Bearer authentication via your secret API Key.
Header KeyValueRequired
AuthorizationBearer <your_api_key>Required
Content-Typeapplication/jsonRequired

Request Parameters

The request body must be formatted as JSON with the following parameters:

ParameterTypeRequiredDescription
name
stringRequired

Full name of the contact.

example: Alex Johnson
phone
stringRequired

Phone number in E.164 format.

example: 628123456789
tags
arrayOptional

Array of tag strings.

example: ["VIP", "Prospect"]
custom_fields
objectOptional

Key-value dictionary for dynamic variable substitution in broadcasts.

example: {"company": "Acme Corp"}

Code Examples

request.sh
curl -X POST "https://api-wa.hidessh.com/api/v1/contacts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Alex Johnson",
    "phone": "628123456789",
    "tags": ["VIP"]
  }'

Response Formats

Contact created successfully.

application/json • 201 Created
{
  "success": true,
  "message": "contact created successfully",
  "payload": {
    "id": "01M1CT001",
    "name": "Alex Johnson",
    "phone": "628123456789"
  }
}