Email Preferences API

GET /v1/email/preferences

Get Preferences

Return current email preferences for the authenticated user and workspace.

Auth: BearerAuth with a user session token (JWT). API keys are rejected.

Response 200 (EmailPreferencesResponse)

curl -X GET "https://api.pinbridge.io/v1/email/preferences" \
  -H "Authorization: Bearer $PINBRIDGE_JWT"

---

PATCH /v1/email/preferences

Update Preferences

Update user-scoped email preferences.

Auth: BearerAuth with a user session token (JWT). API keys are rejected.

Request body (EmailPreferencesUpdateRequest)

Field	Type	Required	Description
transactional_enabled	boolean	yes
alerts_enabled	boolean	yes
verification_enabled	boolean	yes

Response 200 (EmailPreferencesResponse)

curl -X PATCH "https://api.pinbridge.io/v1/email/preferences" \
  -H "Authorization: Bearer $PINBRIDGE_JWT" \
  -H "Content-Type: application/json" \
  -d '{"transactional_enabled": true, "alerts_enabled": true, "verification_enabled": true}'

---

GET /v1/email/unsubscribe

Unsubscribe

Public endpoint: validate token and disable emails for a user.

Parameters

Name	In	Required	Type	Description
workspace_id	query	yes	string
token	query	yes	string
user_id	query	no	string?

Response 200

curl -X GET "https://api.pinbridge.io/v1/email/unsubscribe?workspace_id=$WORKSPACE_ID&token=$TOKEN"

---