Intake
POST /api/intake/email/{org_slug}/{inbox_slug}
Section titled “POST /api/intake/email/{org_slug}/{inbox_slug}”Ingest Email Codeless
Codeless (public) email address: in.{inbox}.{org}@zone.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| inbox_slug | path | string | yes | |
| org_slug | path | string | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 201 | Successful Response | IntakeIngestResponse |
| 422 | Validation Error | HTTPValidationError |
POST /api/intake/email/{org_slug}/{inbox_slug}/{code}
Section titled “POST /api/intake/email/{org_slug}/{inbox_slug}/{code}”Ingest Email Coded
Coded email address: in.{inbox}.{org}.{code}@zone.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| code | path | string | yes | |
| inbox_slug | path | string | yes | |
| org_slug | path | string | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 201 | Successful Response | IntakeIngestResponse |
| 422 | Validation Error | HTTPValidationError |
POST /api/intake/hook/{address_token}
Section titled “POST /api/intake/hook/{address_token}”Ingest Webhook
POST /api/intake/hook/{address_token} — the token-only path shape.
Still the advertised URL where no agent zone is configured (local dev), and kept live everywhere for senders configured before the org-host shape existed. The token is the same credential either way, so nothing is weaker here than on the host route.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| address_token | path | string | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 201 | Successful Response | IntakeIngestResponse |
| 422 | Validation Error | HTTPValidationError |
GET /api/intake/run/{run_token}
Section titled “GET /api/intake/run/{run_token}”Run Status
GET /api/intake/run/{run_token} — the token-only path shape.
The token is the same credential either way, so nothing is weaker here than on the host route.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| run_token | path | string | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | IntakeRunResponse |
| 422 | Validation Error | HTTPValidationError |