Create customer follow up notify due

Scan customers whose nextStepDueAt is past due (terminal stages excluded) and emit a follow_up_due notification to the customer owner — once per (customer, due date).

POST/workspaces/{organizationId}/customers/follow-ups/notify-due

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Request body

application/json

nowstring<date-time>

Responses

200

Due-follow-up scan result

scannedintegerrequired

notifiedintegerrequired

notificationsobject[]required

Show properties

Array of object

customerIdstringrequired

customerNamestringrequired

recipientIdstringrequired

typestringrequired

titlestringrequired

bodystringrequired

nextStepDueAtstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*

Bodyapplication/json

nowstring

Request

curl -X POST 'https://pile.nyc/workspaces/string/customers/follow-ups/notify-due' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "now": "2019-08-24T14:15:22Z"
}'

const response = await fetch("https://pile.nyc/workspaces/string/customers/follow-ups/notify-due", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"now\": \"2019-08-24T14:15:22Z\"\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/customers/follow-ups/notify-due",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"now\": \"2019-08-24T14:15:22Z\"\n}",
)

Response

{
  "scanned": 0,
  "notified": 0,
  "notifications": [
    {
      "customerId": "string",
      "customerName": "string",
      "recipientId": "string",
      "type": "string",
      "title": "string",
      "body": "string",
      "nextStepDueAt": "string"
    }
  ]
}