curl --request POST \
--url 'https://api.peoplewisher.com/v1/contacts' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"first_name": "Ada",
"last_name": "Okafor",
"email": "[email protected]",
"phone": "+2348012345678",
"whatsapp_phone": "+2348012345678",
"birthday": "1994-10-12",
"timezone": "Africa/Lagos",
"location": "Lagos",
"company": "Example Ltd",
"job_title": "Finance Manager",
"group_id": 24
}'
{
"success": true,
"data": {
"contact_id": 4812,
"first_name": "Ada",
"last_name": "Okafor",
"email": "[email protected]",
"phone": "+2348012345678",
"whatsapp_phone": "+2348012345678",
"birthday": "1994-10-12",
"timezone": "Africa/Lagos",
"group_id": 24,
"group_name": "Customers",
"source": "api"
}
}
API Reference
Create a contact
Create a contact and assign it to a Celebration Group. Once the contact is in the group, Peoplewisher handles the configured celebration workflow.
POST
/
contacts
curl --request POST \
--url 'https://api.peoplewisher.com/v1/contacts' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"first_name": "Ada",
"last_name": "Okafor",
"email": "[email protected]",
"phone": "+2348012345678",
"whatsapp_phone": "+2348012345678",
"birthday": "1994-10-12",
"timezone": "Africa/Lagos",
"location": "Lagos",
"company": "Example Ltd",
"job_title": "Finance Manager",
"group_id": 24
}'
{
"success": true,
"data": {
"contact_id": 4812,
"first_name": "Ada",
"last_name": "Okafor",
"email": "[email protected]",
"phone": "+2348012345678",
"whatsapp_phone": "+2348012345678",
"birthday": "1994-10-12",
"timezone": "Africa/Lagos",
"group_id": 24,
"group_name": "Customers",
"source": "api"
}
}
curl --request POST \
--url 'https://api.peoplewisher.com/v1/contacts' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"first_name": "Ada",
"last_name": "Okafor",
"email": "[email protected]",
"phone": "+2348012345678",
"whatsapp_phone": "+2348012345678",
"birthday": "1994-10-12",
"timezone": "Africa/Lagos",
"location": "Lagos",
"company": "Example Ltd",
"job_title": "Finance Manager",
"group_id": 24
}'
{
"success": true,
"data": {
"contact_id": 4812,
"first_name": "Ada",
"last_name": "Okafor",
"email": "[email protected]",
"phone": "+2348012345678",
"whatsapp_phone": "+2348012345678",
"birthday": "1994-10-12",
"timezone": "Africa/Lagos",
"group_id": 24,
"group_name": "Customers",
"source": "api"
}
}
How it works
Required fields
first_name and group_id are required. The group_id determines which celebration category and workflow applies to the contact.
You do not need to create a template, configure a message, or schedule an automation through the API. Configure those settings in Peoplewisher once, then use the API to keep contacts synchronized.
Authentication
Include your Peoplewisher API key as a Bearer token on every request:Authorization: Bearer YOUR_API_KEY
Authorizations
Use the API key generated in Peoplewisher Settings as a Bearer token.
Body
application/json
Required range:
x >= 1Primary phone number.
Birthday in YYYY-MM-DD format. The year may be omitted when only month/day are known.
Example:
"Africa/Lagos"
URL or PeopleWisher-supported profile image reference.