Skip to main content
DELETE

How it works

Deleting a group removes that group from the account. Review the contacts assigned to the group before deleting it if those contacts are still expected to participate in a Peoplewisher workflow.

Authentication

Include your Peoplewisher API key as a Bearer token on every request:
Your API key is available in Peoplewisher → Settings → API. Keep it private and never expose it in browser-side code or public repositories.

Authorizations

Authorization
string
header
required

Use the API key generated in Peoplewisher Settings as a Bearer token.

Path Parameters

group_id
integer
required

Peoplewisher Celebration Group ID.

Required range: x >= 1

Response

Celebration Group deletion accepted

success
boolean