Channels

List SES setups

get

Paginated list of every SES setup on the platform. Items carry the cached dns_verified aggregate; call GET /ses-setup/{id} for per-record DNS detail. Setups are shared platform-wide; any caller with Channel.view permission sees the full list.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Query parameters

limitinteger · max: 20OptionalDefault: 10

continuation_tokenintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenany ofOptional

integerOptional

or

nullOptional

totalany ofOptional

integerOptional

or

nullOptional

403

Insufficient permissions.

422

Validation Error

application/json

get

/v1/{workspace_id}/channels/ses-setup

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/channels/ses-setup HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "tenant_name": "text",
      "domain_identity": "text",
      "dns_verified": true,
      "dns_checked_at": "2026-05-12T12:33:06.321Z",
      "created_at": "2026-05-12T12:33:06.321Z",
      "updated_at": "2026-05-12T12:33:06.321Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1,
  "total": 1
}

Create an SES setup

post

Create an SES tenant + verified email identity. Returns the DNS records the customer must publish (DKIM CNAMEs, MX, DMARC TXT). Subsequent GET or POST /verify calls re-run the live DNS lookup and update the per-record verified flag. Setups are shared platform-wide; any caller with Channel.create permission can create one.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

tenant_namestring · min: 1 · max: 64Required

Logical SES tenant name (reputation + suppression isolation boundary). Unique within the AWS account. Alphabet [A-Za-z0-9_-], 1-64 chars.

Pattern: ^[A-Za-z0-9_-]+$

domain_identitystring · min: 1 · max: 255Required

Domain to verify for both sending and receiving (e.g. mail.customer.com). A single SES identity serves both directions.

Responses

201

Successful Response

application/json

403

Insufficient permissions.

409

Tenant name or domain identity already exists upstream.

422

Invalid SES setup configuration.

502

Channel manager unavailable.

504

Channel manager timed out.

post

/v1/{workspace_id}/channels/ses-setup

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/channels/ses-setup HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "tenant_name": "text",
  "domain_identity": "text"
}

{
  "id": "text",
  "tenant_name": "text",
  "domain_identity": "text",
  "dns_checked_at": "2026-05-12T12:33:06.321Z",
  "dns_records": [
    {
      "address": "text",
      "record": "text",
      "type": "CNAME",
      "verified": true
    }
  ],
  "created_at": "2026-05-12T12:33:06.321Z",
  "updated_at": "2026-05-12T12:33:06.321Z"
}

Get an SES setup with live DNS refresh

get

Returns full SES setup detail including per-record DNS verification status. Channel-manager re-runs GetEmailIdentity + DMARC/MX resolvers on every call, so each GET is a live check. Requires Channel.view permission.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

setup_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstringRequired

tenant_namestringRequired

domain_identitystringRequired

dns_checked_atany ofRequired

string · date-timeOptional

or

nullOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

403

Insufficient permissions.

404

SES setup not found.

422

Validation Error

application/json

get

/v1/{workspace_id}/channels/ses-setup/{setup_id}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/channels/ses-setup/{setup_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "tenant_name": "text",
  "domain_identity": "text",
  "dns_checked_at": "2026-05-12T12:33:06.321Z",
  "dns_records": [
    {
      "address": "text",
      "record": "text",
      "type": "CNAME",
      "verified": true
    }
  ],
  "created_at": "2026-05-12T12:33:06.321Z",
  "updated_at": "2026-05-12T12:33:06.321Z"
}

Delete an SES setup

delete

Tear down the upstream SES tenant + identity. Refuses (409) if any use case still references the setup. Requires Channel.delete permission.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

setup_idstring · uuidRequired

Responses

204

Successful Response

403

Insufficient permissions.

404

SES setup not found.

409

Setup still referenced by live use cases.

422

Validation Error

application/json

502

Channel manager unavailable.

504

Channel manager timed out.

delete

/v1/{workspace_id}/channels/ses-setup/{setup_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/channels/ses-setup/{setup_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Refresh SES DNS verification

post

Explicit DNS refresh endpoint. Equivalent to GET /ses-setup/{id} but exposed as a POST so UI Verify now actions read as actions rather than reads. Requires Channel.view permission.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

setup_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstringRequired

tenant_namestringRequired

domain_identitystringRequired

dns_checked_atany ofRequired

string · date-timeOptional

or

nullOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

403

Insufficient permissions.

404

SES setup not found.

422

Validation Error

application/json

post

/v1/{workspace_id}/channels/ses-setup/{setup_id}/verify

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/channels/ses-setup/{setup_id}/verify HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "tenant_name": "text",
  "domain_identity": "text",
  "dns_checked_at": "2026-05-12T12:33:06.321Z",
  "dns_records": [
    {
      "address": "text",
      "record": "text",
      "type": "CNAME",
      "verified": true
    }
  ],
  "created_at": "2026-05-12T12:33:06.321Z",
  "updated_at": "2026-05-12T12:33:06.321Z"
}