This schema describes objects returned by the Account endpoints.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
email | string (email) | Yes | Email address of the account |
timestamp_created | string (date-time) | Yes | Timestamp when the account was created (read-only) |
timestamp_updated | string (date-time) | Yes | Timestamp when the account was last updated (read-only) |
first_name | string | Yes | First name associated with the account |
last_name | string | Yes | Last name associated with the account |
warmup | object | No | Warmup configuration for the account |
warmup.limit | number | No | Email sending limit for the account |
warmup.advanced | object | No | Advanced settings for the account |
warmup.advanced.warm_ctd | boolean | No | Whether the account is in warm CTD mode |
warmup.advanced.open_rate | number | No | Email open rate for the account |
warmup.advanced.important_rate | number | No | Important email rate for the account |
warmup.advanced.read_emulation | boolean | No | Whether read emulation is enabled |
warmup.advanced.spam_save_rate | number | No | Spam save rate for the account |
warmup.advanced.weekday_only | boolean | No | Whether to send emails only on weekdays |
warmup.warmup_custom_ftag | string | No | Custom tag for the account |
warmup.increment | string | No | Daily increment for email sending limits. Set to disabled to turn off slow ramp.. Possible values: disabled (Disabled), 0 (0), 1 (1), 2 (2), 3 (3), 4 (4) |
warmup.reply_rate | number | No | Reply rate for the account |
added_by | string (uuid), nullable | No | User ID who added the account (read-only) |
daily_limit | number, nullable | No | Daily email sending limit |
modified_by | string (uuid), nullable | No | User ID who last modified the account (read-only) |
tracking_domain_name | string, nullable | No | Tracking domain |
tracking_domain_status | string, nullable | No | Tracking domain status |
status | number | No | Current status of the account. Possible values: 1 (Active), 2 (Paused), 3 (Temporarily paused for maintenance; will be automatically resumed shortly), -1 (Connection Error), -2 (Soft Bounce Error), -3 (Sending Error) (read-only) |
enable_slow_ramp | boolean, nullable | No | Whether to enable slow ramp up for sending limits |
inbox_placement_test_limit | number, nullable | No | The limit for inbox placement tests |
organization | string (uuid) | Yes | Organization ID that owns this account (read-only) |
timestamp_last_used | string (date-time), nullable | No | Timestamp when the account was last used (read-only) |
warmup_status | number | Yes | Current warmup status of the account. Possible values: 0 (Paused), 1 (Active), -1 (Banned), -2 (Spam Folder Unknown), -3 (Permanent Suspension) (read-only) |
status_message | object | No | Status message for the account (read-only) |
status_message.code | string | No | |
status_message.command | string | No | |
status_message.response | string | No | |
status_message.e_message | string | No | |
status_message.responseCode | number | No | |
timestamp_warmup_start | string (date-time), nullable | No | Timestamp when warmup was started (read-only) |
provider_code | number | Yes | Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work.. Possible values: 1 (Custom IMAP/SMTP), 2 (Google), 3 (Microsoft), 4 (AWS), 8 (AirMail) |
setup_pending | boolean | Yes | Whether account setup is pending (read-only) |
warmup_pool_id | string (uuid), nullable | No | ID of the warmup pool this account belongs to (read-only) |
is_managed_account | boolean | Yes | Whether this is a managed account (read-only) |
dfy_password_changed | boolean, nullable | No | Whether DFY password has been changed (read-only) |
stat_warmup_score | number, nullable | No | Warmup score for the account (read-only) |
sending_gap | number | No | The gap between emails sent from this account in minutes (minimum wait time when used with multiple campaigns) |
signature | string, nullable | No | Email signature for the account |