Documents Plugin

Register an inbound capture address on a tenant-owned domain.

POST

http://localhost:3000/api/plugins/docs/inbound-addresses

curl -X POST 'http://localhost:3000/api/plugins/docs/inbound-addresses' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "organizationId": "string",
  "kind": "PLATFORM",
  "domain": "string",
  "localPart": "string",
  "senderAllowlist": [
    "string"
  ],
  "importBodyAsNote": true
}'

const body = `{
  "organizationId": "string",
  "kind": "PLATFORM",
  "domain": "string",
  "localPart": "string",
  "senderAllowlist": [
    "string"
  ],
  "importBodyAsNote": true
}`;

const response = await fetch('http://localhost:3000/api/plugins/docs/inbound-addresses', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "organizationId": "string",
  "kind": "PLATFORM",
  "domain": "string",
  "localPart": "string",
  "senderAllowlist": [
    "string"
  ],
  "importBodyAsNote": true
}'''

response = requests.post(
    'http://localhost:3000/api/plugins/docs/inbound-addresses',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "organizationId": "string",
  "kind": "PLATFORM",
  "domain": "string",
  "localPart": "string",
  "senderAllowlist": [
    "string"
  ],
  "importBodyAsNote": true
}

Body

application/json

organizationIdstring

kindstringPLATFORMCUSTOM_DOMAINrequired

domainstring

localPartstring

senderAllowlistArray<string>

importBodyAsNoteboolean

Response

201Created

Address created; verification pending.

Stack Overflow Website Demo