Site Admin and Data API surfaces.

Payload example

{
  "email": "alice@example.com",
  "role": "admin",
  "externalEmail": "alice.personal@example.org"
}

Response example

{
  "userId": "user_123",
  "email": "alice@example.com",
  "role": "admin",
  "externalEmail": "alice.personal@example.org",
  "inviteSent": true,
  "inviteRecipient": "alice@example.com"
}

Query example

{
  "limit": 50,
  "nextToken": "opaque-token"
}

Response example

{
  "items": [
    {
      "userId": "user_123",
      "email": "alice@example.com",
      "role": "admin",
      "externalEmail": "alice.personal@example.org"
    }
  ],
  "nextToken": "opaque-token"
}

Pagination notes

Repeat the request with nextToken until it is null or omitted.
The route returns at most 50 users per response.

Path example

{
  "userId": "user_123"
}

Response example

{
  "userSub": "sub_123",
  "primaryEmail": "alice@example.com",
  "activeEmail": "alice@example.com",
  "externalEmail": "alice.personal@example.org",
  "settings": {
    "signature": "Sent from Hydrix"
  },
  "createdAt": "2026-03-20T15:00:00.000Z",
  "updatedAt": "2026-03-20T15:00:00.000Z"
}

Payload example

{
  "primaryEmail": "alice@example.com",
  "externalEmail": "alice.personal@example.org",
  "settings": {
    "signature": "Sent from Hydrix"
  }
}

Response example

{
  "userSub": "sub_123",
  "primaryEmail": "alice@example.com",
  "activeEmail": "alice@example.com",
  "externalEmail": "alice.personal@example.org",
  "settings": {
    "signature": "Sent from Hydrix"
  },
  "updatedAt": "2026-03-20T15:30:00.000Z"
}

Path example

{
  "userId": "user_123"
}

Response

Returns 204 No Content on success. It can also return 409 MailboxOwnershipConflict if mailbox ownership cannot be reassigned safely.

Request

No request body.

Response example

{
  "userSub": "sub_123",
  "primaryEmail": "alice@example.com",
  "activeEmail": "alice@example.com",
  "externalEmail": "alice.personal@example.org",
  "settings": {
    "theme": "system"
  }
}

Payload example

{
  "primaryEmail": "alice@example.com",
  "activeEmail": "alice@example.com",
  "externalEmail": "alice.personal@example.org",
  "settings": {
    "theme": "system"
  }
}

Response example

{
  "userSub": "sub_123",
  "primaryEmail": "alice@example.com",
  "activeEmail": "alice@example.com",
  "externalEmail": "alice.personal@example.org",
  "settings": {
    "theme": "system"
  },
  "updatedAt": "2026-03-20T15:30:00.000Z"
}

Payload example

{
  "address": "support@example.com",
  "owners": ["user_123", "user_456"]
}

Response example

{
  "address": "support@example.com",
  "status": "ACTIVE",
  "owners": ["user_123", "user_456"]
}

Query example

{
  "limit": 25,
  "nextToken": "opaque-token"
}

Response example

{
  "items": [
    {
      "address": "support@example.com",
      "status": "ACTIVE",
      "owners": ["user_123", "user_456"]
    }
  ],
  "nextToken": "opaque-token"
}

Payload example

{
  "owners": ["user_123", "user_789"]
}

Response example

{
  "address": "support@example.com",
  "status": "ACTIVE",
  "owners": ["user_123", "user_789"]
}

Path example

{
  "address": "support@example.com"
}

Response

Returns 204 No Content on success.

Payload example

{
  "confirm": true
}

Response

Returns 204 No Content on success.

Payload example

{
  "owners": ["user_123", "user_456"]
}

Response example

{
  "address": "support@example.com",
  "status": "ACTIVE",
  "owners": ["user_123", "user_456"]
}

Path example

{
  "address": "support@example.com"
}

Response example

{
  "mailbox": "support@example.com",
  "trashAutoPurge": true,
  "trashRetentionDays": 30
}

Payload example

{
  "trashAutoPurge": true,
  "trashRetentionDays": 30
}

Response example

{
  "mailbox": "support@example.com",
  "trashAutoPurge": true,
  "trashRetentionDays": 30
}

Payload example

{
  "owners": ["user_789"]
}

Response example

{
  "address": "support@example.com",
  "status": "ACTIVE",
  "owners": ["user_123", "user_456", "user_789"]
}

Payload example

{
  "owners": ["user_456"]
}

Response example

{
  "address": "support@example.com",
  "status": "ACTIVE",
  "owners": ["user_123"]
}

Path example

{
  "address": "support@example.com"
}

Response example

{
  "mailbox": "support@example.com",
  "enabled": true,
  "keepCopy": true,
  "targets": [
    {
      "target": "person@gmail.com",
      "status": "VERIFIED"
    }
  ]
}

Payload example

{
  "enabled": true,
  "keepCopy": true
}

Response example

{
  "mailbox": "support@example.com",
  "enabled": true,
  "keepCopy": true,
  "targets": []
}

Path example

{
  "address": "support@example.com"
}

Response example

{
  "mailbox": "support@example.com",
  "items": [
    {
      "target": "person@gmail.com",
      "status": "VERIFIED",
      "createdAt": "2026-03-20T15:00:00.000Z"
    }
  ]
}

Payload example

{
  "targets": ["person@gmail.com"]
}

Response example

{
  "mailbox": "support@example.com",
  "items": [
    {
      "target": "person@gmail.com",
      "status": "PENDING",
      "verificationSent": true
    }
  ]
}

Payload example

{
  "targets": ["person@gmail.com"]
}

Response

Returns 204 No Content on success.

Payload example

{
  "targets": ["support@example.com", "sales@example.com"]
}

Response example

{
  "address": "hello@example.com",
  "targets": ["support@example.com", "sales@example.com"]
}

Path example

{
  "aliasAddress": "hello@example.com"
}

Response

Returns 204 No Content on success.

Request

No request body.

Response example

{
  "items": [
    {
      "address": "hello@example.com",
      "targets": ["support@example.com", "sales@example.com"]
    }
  ]
}

Query example

{
  "mailbox": "support@example.com",
  "folder": "INBOX",
  "limit": 25,
  "nextToken": "opaque-token",
  "includeDeleted": false
}

Response example

{
  "items": [
    {
      "id": "msg_123",
      "mailbox": "support@example.com",
      "folder": "INBOX",
      "subject": "Question about pricing",
      "hasAttachments": false,
      "seen": false
    }
  ],
  "nextToken": "opaque-token"
}

Path example

{
  "messageId": "msg_123"
}

Response example

{
  "id": "msg_123",
  "mailbox": "support@example.com",
  "folder": "INBOX",
  "from": "customer@example.org",
  "to": ["support@example.com"],
  "subject": "Question about pricing",
  "attachments": [],
  "rawUrl": "https://signed-url",
  "seen": false
}

Path example

{
  "messageId": "msg_123"
}

Response

Returns 204 No Content on success.

Payload example

{
  "mailbox": "support@example.com",
  "filename": "invoice.pdf",
  "contentType": "application/pdf",
  "size": 102400
}

Response example

{
  "attachmentRef": "<opaque-token>",
  "mailbox": "support@example.com",
  "filename": "invoice.pdf",
  "contentType": "application/pdf",
  "size": 102400,
  "upload": {
    "method": "PUT",
    "url": "https://signed-upload",
    "headers": {
      "Content-Type": "application/pdf"
    },
    "expiresAt": "2025-11-12T04:45:00Z"
  }
}

Payload example

{
  "mailbox": "support@example.com",
  "to": ["customer@example.org"],
  "subject": "Reaching out",
  "body": "Hello from Hydrix.",
  "attachmentRefs": ["<opaque-token>"]
}

Response example

{
  "id": "msg_456",
  "threadId": "thread_123"
}

Payload example

{
  "body": "Thanks for reaching out.",
  "subject": "Re: Question about pricing",
  "attachmentRefs": ["<opaque-token>"]
}

Response example

{
  "id": "msg_789",
  "threadId": "thread_123"
}

Path example

{
  "messageId": "msg_123"
}

Response example

{
  "id": "msg_123",
  "deleted": false
}

Path example

{
  "messageId": "msg_123"
}

Response

Returns 204 No Content on success.

Payload example

{
  "seen": true
}

Response example

{
  "id": "msg_123",
  "seen": true
}

Path example

{
  "messageId": "msg_123"
}

Response

Returns 204 No Content on success.

Payload example

{
  "messageIds": ["msg_123", "msg_456"],
  "force": true
}

Response example

{
  "purged": ["msg_123", "msg_456"],
  "failed": []
}

Payload example

{
  "confirm": true,
  "dryRun": false,
  "filters": {
    "mailbox": "support@example.com"
  }
}

Response example

{
  "matchedCount": 12,
  "deletedCount": 12,
  "failedCount": 0,
  "dryRun": false
}

Payload example

{
  "confirm": true,
  "dryRun": false
}

Response example

{
  "matchedCount": 42,
  "deletedCount": 42,
  "failedCount": 0,
  "dryRun": false
}

Request

No request body.

Response example

{
  "items": [
    {
      "email": "contact@example.com",
      "createdAt": "2026-03-20T15:00:00.000Z",
      "updatedAt": "2026-03-20T15:00:00.000Z"
    }
  ]
}

Payload example

{
  "recipients": ["contact@example.com", "sales@example.com"]
}

Response example

{
  "items": [
    {
      "email": "contact@example.com"
    },
    {
      "email": "sales@example.com"
    }
  ]
}

Payload example

{
  "recipients": ["sales@example.com"]
}

Response

Returns 204 No Content on success.

Request

No request body.

Response example

{
  "siteId": "site_123",
  "authEmailBranding": {
    "adminVerificationEmail": {
      "subject": "Your admin code",
      "htmlBody": "<p>Your code is <strong>{{code}}</strong>.</p>"
    }
  },
  "messageTypes": ["adminVerificationEmail", "dataVerificationEmail"]
}

Payload example

{
  "adminVerificationEmail": {
    "subject": "Your admin code",
    "htmlBody": "<p>Your code is <strong>{{code}}</strong>.</p>"
  },
  "dataVerificationEmail": null
}

Response example

{
  "siteId": "site_123",
  "authEmailBranding": {
    "adminVerificationEmail": {
      "subject": "Your admin code",
      "htmlBody": "<p>Your code is <strong>{{code}}</strong>.</p>"
    }
  }
}

Payload example

{
  "superAdminEmails": ["owner@example.com"]
}

Response example

{
  "matchedCount": 1,
  "resentCount": 1,
  "status": "sent"
}

Payload example

{
  "type": "ddbTable",
  "name": "profiles",
  "config": {
    "partitionKey": {
      "name": "pk",
      "type": "S"
    }
  }
}

Response example

{
  "resourceId": "res_profiles",
  "type": "ddbTable",
  "name": "profiles",
  "permissionsSync": {
    "status": "queued"
  }
}

Request

No request body.

Response example

{
  "resources": [
    {
      "resourceId": "res_profiles",
      "type": "ddbTable",
      "name": "profiles"
    }
  ],
  "operations": []
}

Payload example

{
  "name": "profiles-v2",
  "config": {
    "ttlAttribute": "expiresAt"
  }
}

Response example

{
  "resourceId": "res_profiles",
  "type": "ddbTable",
  "name": "profiles-v2"
}

Path example

{
  "resourceId": "res_profiles"
}

Response example

{
  "ok": true
}

Payload example

{
  "key": {
    "pk": "user#123"
  }
}

Response example

{
  "item": {
    "pk": "user#123",
    "name": "Ada"
  }
}

Payload example

{
  "prefix": "uploads/",
  "maxKeys": 25
}

Response example

{
  "items": [
    {
      "key": "uploads/example.txt"
    }
  ]
}

Payload example

{
  "operation": "getProfile",
  "lambdaResourceId": "res_profiles_handler",
  "auth": {
    "mode": "authenticated"
  },
  "cache": {
    "ttlSeconds": 60
  }
}

Response example

{
  "operation": "getProfile",
  "resourceId": "res_profiles_handler",
  "permissionsSync": {
    "status": "queued"
  }
}

Path example

{
  "operation": "getProfile"
}

Response example

{
  "ok": true
}

Path example

{
  "operation": "getProfile"
}

Response example

{
  "ok": true,
  "invalidatedCount": 3
}

Request

No request body.

Response example

{
  "status": "queued",
  "permissionsSync": {
    "status": "queued"
  }
}

Request

No request body.

Response example

{
  "items": [
    {
      "jobId": "nightly-sync",
      "operation": "syncProfiles"
    }
  ]
}

Payload example

{
  "operation": "syncProfiles",
  "payload": {
    "full": true
  },
  "schedule": {
    "cron": "0 2 * * *"
  }
}

Response example

{
  "jobId": "nightly-sync",
  "operation": "syncProfiles",
  "schedule": {
    "cron": "0 2 * * *"
  }
}

Payload example

{
  "trigger": "manual"
}

Response example

{
  "ok": true,
  "data": {
    "jobId": "nightly-sync",
    "status": "started"
  }
}

Path example

{
  "jobId": "nightly-sync"
}

Response example

{
  "ok": true
}

Request

No request body.

Response example

{
  "items": [
    {
      "groupName": "members",
      "description": "Authenticated members"
    }
  ]
}

Payload example

{
  "groupName": "members",
  "description": "Authenticated members"
}

Response example

{
  "groupName": "members",
  "description": "Authenticated members"
}

Path example

{
  "groupName": "members"
}

Response example

{
  "ok": true
}

Payload example

{
  "username": "visitor@example.com"
}

Response example

{
  "groupName": "members",
  "username": "visitor@example.com",
  "ok": true
}

Payload example

{
  "username": "visitor@example.com"
}

Response example

{
  "groupName": "members",
  "username": "visitor@example.com",
  "ok": true
}

Request

No request body.

Response example

{
  "items": [
    {
      "name": "API_BASE_URL",
      "secret": false,
      "value": "https://api.example.com"
    }
  ]
}

Payload example

{
  "storageBackend": "ssmSecureString",
  "variables": {
    "API_BASE_URL": {
      "value": "https://api.example.com"
    },
    "API_SECRET": {
      "value": "secret-value",
      "secret": true
    }
  }
}

Response example

{
  "items": [
    {
      "name": "API_BASE_URL",
      "secret": false
    },
    {
      "name": "API_SECRET",
      "secret": true
    }
  ]
}

Request

No request body.

Response example

{
  "ok": true
}

Payload example

{
  "code": "module.exports = async ({ payload }) => ({ echoed: payload });",
  "payload": {
    "hello": "world"
  },
  "timeoutSeconds": 10
}

Response example

{
  "ok": true,
  "data": {
    "echoed": {
      "hello": "world"
    }
  }
}

Payload example

{
  "mode": "apply",
  "definitionProfileName": "baseline",
  "persistDefinition": false,
  "definition": {
    "resources": [
      {
        "type": "ddbTable",
        "name": "profiles"
      }
    ]
  }
}

Response example

{
  "jobId": "iac_job_123",
  "status": "queued",
  "definitionSource": "inline",
  "definitionPersisted": false
}

Request

No request body.

Response example

{
  "items": [
    {
      "jobId": "iac_job_123",
      "status": "running",
      "definitionSource": "profile"
    }
  ]
}

Path example

{
  "jobId": "iac_job_123"
}

Response example

{
  "jobId": "iac_job_123",
  "status": "succeeded",
  "definitionSource": "profile",
  "permissionsSync": {
    "status": "queued"
  }
}

Request

No request body.

Response example

{
  "items": [
    {
      "profileName": "baseline",
      "updatedAt": "2026-03-20T15:00:00.000Z"
    }
  ]
}

Path example

{
  "profileName": "baseline"
}

Response example

{
  "profileName": "baseline",
  "definition": {
    "resources": [
      {
        "type": "ddbTable",
        "name": "profiles"
      }
    ]
  }
}

Payload example

{
  "definition": {
    "resources": [
      {
        "type": "ddbTable",
        "name": "profiles"
      }
    ]
  },
  "overwriteDefinition": true
}

Response example

{
  "profileName": "baseline",
  "definition": {
    "resources": [
      {
        "type": "ddbTable",
        "name": "profiles"
      }
    ]
  }
}

Path example

{
  "profileName": "baseline"
}

Response example

{
  "ok": true
}