Create customer send gate

POST/workspaces/{organizationId}/customers/{id}/send-gate

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

touchIdstring

default: "touch-preview"

channelstringrequired

Allowed:emailcallvisitlinkedin

actionstring

default: "engage"

Allowed:engageclaim

contactIdstring

default: "default-contact"

contactEmailstring

emailStatusstring

Allowed:validinvalidcatch_allroleunknown

emailVerifiedAtstring

doNotContactboolean

doNotEmailboolean

doNotCallboolean

euResidentboolean

hasExplicitConsentboolean

allowCatchAllboolean

allowRoleboolean

allowUnverifiedboolean

Responses

200

Deterministic send/claim GateDecision

touchIdstringrequired

channelstringrequired

resultstringrequired

Allowed:passwarnblock

reasonsstring[]required

matchedExclusionsstring[]required

evaluatedAtstringrequired

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

touchIdstringchannelstring*actionstringcontactIdstringcontactEmailstringemailStatusstringemailVerifiedAtstringdoNotContactbooleandoNotEmailbooleandoNotCallbooleaneuResidentbooleanhasExplicitConsentbooleanallowCatchAllbooleanallowRolebooleanallowUnverifiedboolean

Request

curl -X POST 'https://pile.nyc/workspaces/string/customers/string/send-gate' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "touchId": "touch-preview",
  "channel": "email",
  "action": "engage",
  "contactId": "default-contact",
  "contactEmail": "string",
  "emailStatus": "valid",
  "emailVerifiedAt": "string",
  "doNotContact": true,
  "doNotEmail": true,
  "doNotCall": true,
  "euResident": true,
  "hasExplicitConsent": true,
  "allowCatchAll": true,
  "allowRole": true,
  "allowUnverified": true
}'

const response = await fetch("https://pile.nyc/workspaces/string/customers/string/send-gate", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"touchId\": \"touch-preview\",\n  \"channel\": \"email\",\n  \"action\": \"engage\",\n  \"contactId\": \"default-contact\",\n  \"contactEmail\": \"string\",\n  \"emailStatus\": \"valid\",\n  \"emailVerifiedAt\": \"string\",\n  \"doNotContact\": true,\n  \"doNotEmail\": true,\n  \"doNotCall\": true,\n  \"euResident\": true,\n  \"hasExplicitConsent\": true,\n  \"allowCatchAll\": true,\n  \"allowRole\": true,\n  \"allowUnverified\": true\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/customers/string/send-gate",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"touchId\": \"touch-preview\",\n  \"channel\": \"email\",\n  \"action\": \"engage\",\n  \"contactId\": \"default-contact\",\n  \"contactEmail\": \"string\",\n  \"emailStatus\": \"valid\",\n  \"emailVerifiedAt\": \"string\",\n  \"doNotContact\": true,\n  \"doNotEmail\": true,\n  \"doNotCall\": true,\n  \"euResident\": true,\n  \"hasExplicitConsent\": true,\n  \"allowCatchAll\": true,\n  \"allowRole\": true,\n  \"allowUnverified\": true\n}",
)

Response

{
  "touchId": "string",
  "channel": "string",
  "result": "pass",
  "reasons": [
    "string"
  ],
  "matchedExclusions": [
    "string"
  ],
  "evaluatedAt": "string"
}