curl --request POST \
--url 'https://api.peoplewisher.com/v1/celebration-groups' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"name": "Customers",
"category": "birthday"
}'
{
"success": true,
"data": {
"group_id": 24,
"name": "Customers",
"category": "birthday"
}
}
API Reference
Create a Celebration Group
Create a Celebration Group that contacts can be assigned to.
POST
/
celebration-groups
curl --request POST \
--url 'https://api.peoplewisher.com/v1/celebration-groups' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"name": "Customers",
"category": "birthday"
}'
{
"success": true,
"data": {
"group_id": 24,
"name": "Customers",
"category": "birthday"
}
}
curl --request POST \
--url 'https://api.peoplewisher.com/v1/celebration-groups' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"name": "Customers",
"category": "birthday"
}'
{
"success": true,
"data": {
"group_id": 24,
"name": "Customers",
"category": "birthday"
}
}
How it works
Creating a group does not create or configure the messages sent to its members. Configure the group’s celebration settings, templates, channels, and workflow inside PeopleWisher.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