Create customer run play

POST/workspaces/{organizationId}/customers/{id}/run-play

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

organizationIdstringrequired

idstringrequired

Request body

application/json

playNamestring

htmlstring

pageUrlstring

contactEmailstring

minDraftRankScorenumber

paidRankThresholdnumber

Responses

200

Executed lead play and queued awaiting_approval draft

object

404

Customer not found

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*idpath*

Bodyapplication/json

playNamestringhtmlstringpageUrlstringcontactEmailstringminDraftRankScorenumberpaidRankThresholdnumber

Request

curl -X POST 'https://pile.nyc/workspaces/string/customers/string/run-play' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "playName": "string",
  "html": "string",
  "pageUrl": "string",
  "contactEmail": "string",
  "minDraftRankScore": 0,
  "paidRankThreshold": 0
}'

const response = await fetch("https://pile.nyc/workspaces/string/customers/string/run-play", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"playName\": \"string\",\n  \"html\": \"string\",\n  \"pageUrl\": \"string\",\n  \"contactEmail\": \"string\",\n  \"minDraftRankScore\": 0,\n  \"paidRankThreshold\": 0\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/customers/string/run-play",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"playName\": \"string\",\n  \"html\": \"string\",\n  \"pageUrl\": \"string\",\n  \"contactEmail\": \"string\",\n  \"minDraftRankScore\": 0,\n  \"paidRankThreshold\": 0\n}",
)

Response

{
  "property1": null,
  "property2": null
}