Agent Email
Create an agent email inbox
POST /v1/agent-email/inboxes · SDK createAgentEmailInbox · CLI deployments inbox create
POST
Requires agent-email:write.
platformBearerheader
AuthorizationBearer <token>Platform bearer credential accepted as an opaque API key or JWT.
x-deployments-environment*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$idempotency-key*stringLength
1 <= length <= 512application/json- body
clientId?stringdomainId?stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$localPart?stringMatch
^\S[\s\S]*\S$|^\S$|^$Length
1 <= length <= 64metadata?name?stringMatch
^\S[\s\S]*\S$|^\S$|^$Length
1 <= length <= 120AgentEmailInboxResponse
application/json- response
address*stringMatch
^\S[\s\S]*\S$|^\S$|^$Length
3 <= length <= 320clientId?stringcreatedAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timedomainId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$id*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$localPart*stringmetadata*name?stringorganizationId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$status*stringValue in
"active""archived""paused"updatedAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timecurl -X POST "https://example.com/v1/agent-email/inboxes" \ -H "x-deployments-environment: string" \ -H "idempotency-key: string" \ -H "Content-Type: application/json" \ -d '{}'{ "address": "string", "clientId": "string", "createdAt": "2019-08-24T14:15:22Z", "domainId": "string", "id": "string", "localPart": "string", "metadata": { "property1": null, "property2": null }, "name": "string", "organizationId": "string", "status": "active", "updatedAt": "2019-08-24T14:15:22Z"}