Create support customer

POST/workspaces/{organizationId}/support/customers

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

emailstring<email>required

fullNamestring

phonestring

userIdstring

externalIdstring

externalSourcestring

companiesobject[]

Show properties

Array of object

companyIdstringrequired

isPrimaryboolean

default: false

identitiesobject[]

Show properties

Array of object

typestringrequired

Allowed:emailphoneslackmsteamsdiscordwhatsappchatapisocialcustom

subTypestring

valuestringrequired

isPrimaryboolean

default: false

Responses

201

Customer created

customerobjectrequired

Show properties

idstringrequired

organizationIdstringrequired

userIdstring | nullrequired

externalIdstring | nullrequired

externalSourcestringrequired

emailstringrequired

fullNamestring | nullrequired

phonestring | nullrequired

emailOptOutbooleanrequired

emailOptOutAtstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

companiesobject[]required

Show properties

Array of object

idstringrequired

customerIdstringrequired

companyIdstringrequired

namestring | nullrequired

isPrimarybooleanrequired

createdAtstringrequired

identitiesobject[]required

Show properties

Array of object

idstringrequired

customerIdstringrequired

typestringrequired

Allowed:emailphoneslackmsteamsdiscordwhatsappchatapisocialcustom

subTypestring | nullrequired

valuestringrequired

isPrimarybooleanrequired

createdAtstringrequired

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/support/customers' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "user@example.com",
  "fullName": "string",
  "phone": "string",
  "userId": "string",
  "externalId": "string",
  "externalSource": "string",
  "companies": [
    {
      "companyId": "string",
      "isPrimary": false
    }
  ],
  "identities": [
    {
      "type": "email",
      "subType": "string",
      "value": "string",
      "isPrimary": false
    }
  ]
}'

const response = await fetch("https://pile.nyc/workspaces/string/support/customers", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"email\": \"user@example.com\",\n  \"fullName\": \"string\",\n  \"phone\": \"string\",\n  \"userId\": \"string\",\n  \"externalId\": \"string\",\n  \"externalSource\": \"string\",\n  \"companies\": [\n    {\n      \"companyId\": \"string\",\n      \"isPrimary\": false\n    }\n  ],\n  \"identities\": [\n    {\n      \"type\": \"email\",\n      \"subType\": \"string\",\n      \"value\": \"string\",\n      \"isPrimary\": false\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/support/customers",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"email\": \"user@example.com\",\n  \"fullName\": \"string\",\n  \"phone\": \"string\",\n  \"userId\": \"string\",\n  \"externalId\": \"string\",\n  \"externalSource\": \"string\",\n  \"companies\": [\n    {\n      \"companyId\": \"string\",\n      \"isPrimary\": false\n    }\n  ],\n  \"identities\": [\n    {\n      \"type\": \"email\",\n      \"subType\": \"string\",\n      \"value\": \"string\",\n      \"isPrimary\": false\n    }\n  ]\n}",
)

Response

{
  "customer": {
    "id": "string",
    "organizationId": "string",
    "userId": "string",
    "externalId": "string",
    "externalSource": "string",
    "email": "string",
    "fullName": "string",
    "phone": "string",
    "emailOptOut": true,
    "emailOptOutAt": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "companies": [
      {
        "id": "string",
        "customerId": "string",
        "companyId": "string",
        "name": "string",
        "isPrimary": true,
        "createdAt": "string"
      }
    ],
    "identities": [
      {
        "id": "string",
        "customerId": "string",
        "type": "email",
        "subType": "string",
        "value": "string",
        "isPrimary": true,
        "createdAt": "string"
      }
    ]
  }
}