curl --request PATCH \
--url 'https://api.peoplewisher.com/v1/contacts/4812' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"first_name": "Ada",
"last_name": "Okafor",
"email": "[email protected]",
"birthday": "1994-10-13",
"timezone": "Africa/Lagos",
"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-13",
"timezone": "Africa/Lagos",
"group_id": 24,
"group_name": "Customers",
"source": "api"
}
}
API Reference
Update a contact
Update an existing contact in your Peoplewisher account.
PATCH
/
contacts
/
{contact_id}
curl --request PATCH \
--url 'https://api.peoplewisher.com/v1/contacts/4812' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"first_name": "Ada",
"last_name": "Okafor",
"email": "[email protected]",
"birthday": "1994-10-13",
"timezone": "Africa/Lagos",
"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-13",
"timezone": "Africa/Lagos",
"group_id": 24,
"group_name": "Customers",
"source": "api"
}
}
curl --request PATCH \
--url 'https://api.peoplewisher.com/v1/contacts/4812' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"first_name": "Ada",
"last_name": "Okafor",
"email": "[email protected]",
"birthday": "1994-10-13",
"timezone": "Africa/Lagos",
"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-13",
"timezone": "Africa/Lagos",
"group_id": 24,
"group_name": "Customers",
"source": "api"
}
}
How it works
Use the Peoplewishercontact_id returned when the contact is created. Updating group_id moves the contact to the selected Celebration Group. If the birthday changes, Peoplewisher updates the relevant birthday processing state.
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.
Path Parameters
Peoplewisher contact ID.
Required range:
x >= 1Body
application/json
Primary 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.
Required range:
x >= 1