post/inboxes

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/inboxes
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

usernamestring

Local part of the inbox email address (letters, numbers, dots, hyphens, underscores). Normalized to lowercase.

domainstring

Domain for the inbox email address; uses the default domain if omitted

displayNamestring

Human-readable display name for the inbox (max 128 characters)

agentIdstring

ID of the agent to associate with this inbox. With an agent-scoped key, defaults to the calling agent and may only name that agent; naming a different agent requires a master key. With a master key, omitting it creates a dedicated backing agent for the inbox.

Response

OK

idstring required

Unique identifier of the inbox

emailstring email required

Full email address of the inbox

domainstring required

Domain portion of the inbox email address

localPartstring required

Local part (before the @) of the inbox email address

displayNamestring nullable required

Human-readable display name, or null if not set

agentIdstring required

ID of the agent this inbox belongs to

createdAtstring date-time required

Timestamp when the inbox was created

Changes

No recorded changes to this operation across all 1 revision of this API.