API & development

Mail domain, mailbox and sending-policy data fields

Exact JSON field names and types, with public-request versus protected-state boundaries.

Platform: Go
Technology: Go

How to use these fields

This release-matched technical reference indexes the JSON-visible fields in the reviewed typed models. Start with the operational guide and API conventions. A model is not a public mutation schema: request structs, response records, protected plans and internal receipts serve different purposes. Submit only the fields supported by the exact endpoint/client; unknown fields are rejected. Internal sequence, signature, receipt, owner and generation values cannot be edited to grant authority. Optional means a Go JSON field can be omitted when empty; it does not waive an endpoint prerequisite. Values containing credentials/secrets must use the protected write-only form, never logs, query strings or support screenshots. Current account ownership, grants, feature/licence state and capability still apply.

Domain

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`account_id`	`string`	Encoded by this model
`name`	`string`	Encoded by this model
`routing`	`string`	Encoded by this model
`remote_mx`	`[]string`	Encoded by this model
`status`	`string`	Encoded by this model
`account_blocked`	`bool`	Encoded by this model
`revision`	`int64`	Encoded by this model
`mailbox_count`	`int`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model
`updated_at`	`time.Time`	Encoded by this model

Mailbox

JSON field	Type	Presence
`id`	`string`	Encoded by this model
`domain_id`	`string`	Encoded by this model
`account_id`	`string`	Encoded by this model
`local_part`	`string`	Encoded by this model
`address`	`string`	Encoded by this model
`status`	`string`	Encoded by this model
`revision`	`int64`	Encoded by this model
`credential_revision`	`int64`	Encoded by this model
`quota_bytes`	`int64`	Encoded by this model
`quota_enforced`	`bool`	Encoded by this model
`usage_bytes`	`*int64`	Optional when empty
`message_count`	`*int64`	Optional when empty
`pop3_enabled`	`bool`	Encoded by this model
`account_blocked`	`bool`	Encoded by this model
`created_at`	`time.Time`	Encoded by this model
`updated_at`	`time.Time`	Encoded by this model

Policy

JSON field	Type	Presence
`account_id`	`string`	Encoded by this model
`revision`	`int64`	Encoded by this model
`status`	`string`	Encoded by this model
`configuration`	`lifecycle.SendPolicy`	Encoded by this model
`updated_at`	`time.Time`	Encoded by this model

CreateDomainRequest

JSON field	Type	Presence
`account_id`	`string`	Encoded by this model
`name`	`string`	Encoded by this model
`routing`	`string`	Encoded by this model
`remote_mx`	`[]string`	Optional when empty

DomainChangeRequest

JSON field	Type	Presence
`revision`	`int64`	Encoded by this model
`routing`	`string`	Optional when empty
`remote_mx`	`[]string`	Optional when empty

CreateMailboxRequest

JSON field	Type	Presence
`local_part`	`string`	Encoded by this model
`password`	`string`	Encoded by this model
`quota_bytes`	`int64`	Encoded by this model
`pop3_enabled`	`bool`	Encoded by this model

MailboxChangeRequest

JSON field	Type	Presence
`revision`	`int64`	Encoded by this model
`password`	`string`	Optional when empty

PolicyRequest

JSON field	Type	Presence
`revision`	`int64`	Encoded by this model

Submission

JSON field	Type	Presence
`domain`	`*Domain`	Optional when empty
`mailbox`	`*Mailbox`	Optional when empty
`policy`	`*Policy`	Optional when empty
`tools`	`*DomainTools`	Optional when empty
`operation`	`operations.Operation`	Encoded by this model
`replayed`	`bool`	Encoded by this model

accountHookPlan

JSON field	Type	Presence
`domains`	`[]lifecycle.Plan`	Encoded by this model

accountHookReceipt

JSON field	Type	Presence
`operation_id`	`string`	Encoded by this model
`generation`	`int64`	Encoded by this model
`action`	`string`	Encoded by this model
`phase`	`string`	Encoded by this model
`domains`	`[]accountHookDomain`	Encoded by this model

accountHookDomain

JSON field	Type	Presence
`operation_id`	`string`	Encoded by this model
`plan`	`lifecycle.Plan`	Encoded by this model
`receipt`	`json.RawMessage`	Encoded by this model

Verify the actual endpoint

Read a harmless authorized resource and validate the returned API/model version before automation. For a write, use current revision or ETag, the endpoint-specific secret/preview contract and a stable reviewed idempotency key. Follow the durable task to its final state and inspect service evidence. Missing/unqualified native behavior remains a release limitation; a field name does not prove a live service or complete recovery.

← All EmailaPanel guides Get help →

Need help with EmailaPanel?

Tell us the product version and what you are trying to do. Keep passwords and private keys out of your message.

Contact Emaila