> ## Documentation Index
> Fetch the complete documentation index at: https://developer.peoplewisher.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Peoplewisher Developer API

> Add Peoplewisher celebration automation to your product by syncing contacts into the right Celebration Groups.

Peoplewisher is the celebration engine. Your application provides the people and places them in the right **Celebration Group**; Peoplewisher takes care of the celebration workflow from there.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Get an API key and make your first request.
  </Card>

  <Card title="API reference" icon="code" href="/api-reference/contacts-list">
    Browse the complete API reference.
  </Card>
</CardGroup>

## The integration model

The API is deliberately simple:

1. Get an API key from **Peoplewisher → Settings**.
2. Create or identify the Celebration Group you want to use.
3. Send your contacts to Peoplewisher and assign each contact to its group.
4. Peoplewisher continues the workflow automatically.

You do **not** need to recreate PeopleWisher's celebration engine inside your product.

Templates, celebration settings, message content, channels, delivery timing, and the automation rules for a group are managed by the Peoplewisher account owner in the Peoplewisher application.

### What your application owns

Your application remains the source of truth for your own users and customer records. Use the API to keep the relevant Peoplewisher contact data synchronized and to place each person in the appropriate group.

### What Peoplewisher owns

Peoplewisher owns the celebration workflow after the contact is in the group:

* celebration timing
* email, SMS, and WhatsApp configuration
* templates and message content
* group celebration settings
* delivery processing
* delivery reporting

This separation means you can change a celebration message or delivery schedule in Peoplewisher without changing your integration.

## Built for SaaS and multi-tenant applications

Peoplewisher can be used by a SaaS application that serves multiple organizations or customers.

A common model is:

```text theme={null}
Your SaaS
  ├── Customer A
  │     ├── users
  │     └── Peoplewisher Celebration Group
  │
  ├── Customer B
  │     ├── users
  │     └── Peoplewisher Celebration Group
  │
  └── Customer C
        ├── users
        └── Peoplewisher Celebration Group
```

The API key authenticates against the Peoplewisher account that owns the data. Your application should maintain its own mapping between its tenant/customer IDs and the corresponding Peoplewisher `group_id` values.

If each customer needs an independently managed Peoplewisher account, each account can use its own Peoplewisher API key.

## Do I need to build the workflows?

No.

You do not need API calls for:

* creating message templates
* writing the SMS message
* writing the email
* configuring WhatsApp messages
* choosing delivery times
* enabling or disabling channels
* changing celebration settings for a group

Those are configured directly in PeopleWisher.

## What happens after I create a contact?

Once the contact is created in a Celebration Group, PeopleWisher's existing automation engine can process the contact according to that group's configuration.

For example, if a group is configured for birthday celebrations with email and WhatsApp enabled, adding a person with a birthday to that group is enough for Peoplewisher to handle the configured workflow.

## Supported channels

Peoplewisher supports:

* Email
* SMS
* WhatsApp

Channel configuration is managed in Peoplewisher rather than through the public API.

## Enterprise capabilities

Some platform capabilities are available by Enterprise agreement:

* outbound webhook access
* delivery-status forwarding to your HTTP endpoint
* higher-volume or specialized API requirements

Contact Peoplewisher to discuss Enterprise access.