Skip to content

Email Settings

Read and update email-notification preferences. Preferences are user-scoped: they belong to the user who created the API key.

GET   /v1/settings/email
PATCH /v1/settings/email

Get settings

GET /v1/settings/email

Returns the resolved value for every known email key — keys without an explicit setting come back as true (the implicit "send" default):

json
{
  "data": {
    "customer_license_created": true,
    "customer_license_expiring": true,
    "developer_payment_completed": false
  }
}

(The exact key set depends on the current catalog of customer-facing and developer-facing emails.)

Update settings

PATCH /v1/settings/email

Send a partial map of {key: bool} — only the entries present are updated:

json
{
  "developer_payment_completed": false
}
json
{
  "data": {
    "message": "Email settings updated"
  }
}

Unknown keys are rejected with 400 so a typo can't silently land.

Example

bash
curl -X PATCH "https://api.packedge.dev/v1/settings/email" \
  -H "Authorization: Bearer pk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "developer_payment_completed": false }'