Create customer dedup key

POST/workspaces/{organizationId}/customers/dedup-key

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

namestringrequired

min length 1

addressstring | null

phonestring | null

domainstring | null

Responses

200

Normalized SMB match key and any matching existing customer

matchKeystringrequired

normalizedNamestringrequired

normalizedAddressstringrequired

phoneE164stringrequired

normalizedDomainstringrequired

matchedCustomerIdstring | nullrequired

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

namestring*addressstringphonestringdomainstring

Request

curl -X POST 'https://pile.nyc/workspaces/string/customers/dedup-key' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "address": "string",
  "phone": "string",
  "domain": "string"
}'

const response = await fetch("https://pile.nyc/workspaces/string/customers/dedup-key", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"address\": \"string\",\n  \"phone\": \"string\",\n  \"domain\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/customers/dedup-key",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"address\": \"string\",\n  \"phone\": \"string\",\n  \"domain\": \"string\"\n}",
)

Response

{
  "matchKey": "string",
  "normalizedName": "string",
  "normalizedAddress": "string",
  "phoneE164": "string",
  "normalizedDomain": "string",
  "matchedCustomerId": "string"
}