Create email inboxe

POST/workspaces/{organizationId}/email-inboxes

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

addressstring<email>required

teamIdstring

projectIdstring

customerIdstring

enabledboolean

default: true

Responses

201

Email inbox created

idstringrequired

organizationIdstringrequired

addressstringrequired

teamIdstring | nullrequired

projectIdstring | nullrequired

customerIdstring | nullrequired

enabledbooleanrequired

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

addressstring*teamIdstringprojectIdstringcustomerIdstringenabledboolean

Request

curl -X POST 'https://pile.nyc/workspaces/string/email-inboxes' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "address": "user@example.com",
  "teamId": "string",
  "projectId": "string",
  "customerId": "string",
  "enabled": true
}'

const response = await fetch("https://pile.nyc/workspaces/string/email-inboxes", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"address\": \"user@example.com\",\n  \"teamId\": \"string\",\n  \"projectId\": \"string\",\n  \"customerId\": \"string\",\n  \"enabled\": true\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/email-inboxes",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"address\": \"user@example.com\",\n  \"teamId\": \"string\",\n  \"projectId\": \"string\",\n  \"customerId\": \"string\",\n  \"enabled\": true\n}",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "address": "string",
  "teamId": "string",
  "projectId": "string",
  "customerId": "string",
  "enabled": true,
  "createdAt": "string",
  "updatedAt": "string"
}