Check for an existing AgentMail address using a saved credential
POST
/api/companies/{companyId}/email/connections/{connectionId}/check-addressPersonal API keyAgent API keyConsole session
Check for an existing AgentMail address using a saved credential.
Requires a board connection manager and enabled chat connectors. Read-only: does not create or reserve an inbox. A missing inbox returns unknown because AgentMail hides resources outside the credential scope; it is never proof of availability.
Authorization
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.
Path parameters
companyIdstring (uuid)RequiredThe organization's id.
connectionIdstring (uuid)RequiredThe connection's id.
Request body
application/json · required
usernamestringRequired
at most 64 characterspattern: ^[a-z0-9][a-z0-9._-]*$domainstringRequired
at most 253 characterspattern: ^[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?\.[a-z]{2,}$Responses
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
429AgentMail request limit reached; retry laterToo many requests; wait for
Retry-After seconds.502Internal server error
Errors return {"error": "..."}, often with a code and details. See errors and limits.