Create push send

POST/workspaces/{organizationId}/push/send

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

tokenIdstring

userIdstring

titlestringrequired

min length 1

bodystringrequired

min length 1

dataobject

default: {}

Responses

202

Push delivery accepted

deliveriesobject[]required

Show properties

Array of object

idstringrequired

organizationIdstringrequired

tokenIdstringrequired

userIdstringrequired

payloadstringrequired

statusstringrequired

errorstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

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

Request body

Request

curl -X POST 'https://pile.nyc/workspaces/string/push/send' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "tokenId": "string",
  "userId": "string",
  "title": "string",
  "body": "string",
  "data": {}
}'

const response = await fetch("https://pile.nyc/workspaces/string/push/send", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"tokenId\": \"string\",\n  \"userId\": \"string\",\n  \"title\": \"string\",\n  \"body\": \"string\",\n  \"data\": {}\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/push/send",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"tokenId\": \"string\",\n  \"userId\": \"string\",\n  \"title\": \"string\",\n  \"body\": \"string\",\n  \"data\": {}\n}",
)

Response

{
  "deliveries": [
    {
      "id": "string",
      "organizationId": "string",
      "tokenId": "string",
      "userId": "string",
      "payload": "string",
      "status": "string",
      "error": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}