PilotFoxDocs

Set the new-sale email recipients

PUT
/api/v1/sites/{siteId}/notifications/email

Replaces the members who get an email for each new sale; each must be a member who can read the site's revenue (400 otherwise).

Requires site:update on the site (an API key, or a signed-in member's role). Share links: 401.

Authorization

headerx-api-key<token>

An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).

Scope: site:update

Path Parameters

siteId*string

Request Body

application/json
  1. body
userIds*array<>

The members new-sale emails go to (replaces the list)

Itemsitems <= 200

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PUT 'https://pilotfox.app/api/v1/sites/string/notifications/email' \  -H 'Content-Type: application/json' \  -d '{  "userIds": [    "416ebe2c-ad2f-4853-b1f3-0c3479151dfe"  ]}'
Example Response200
{  "data": {    "recipients": [      "string"    ],    "members": [      {        "userId": "string",        "name": "string",        "email": "string"      }    ],    "webhooks": [      {        "kind": "slack",        "connected": true,        "enabled": true,        "urlHint": "string",        "lastError": "string",        "lastSentAt": "string"      }    ]  }}