Create subaccount allows Partners to create a subaccount within the CiiRUS-API. Subaccounts are typically used to manage and send emails from specific domains or for distinct purposes. This API enables Partners to programmatically create a subaccount for their email management needs.
Endpoints Available
Method
Endpoint
Description
POST
v2024.07.31/emails/subaccount
Creates a subaccount with specific configurations and settings
Body Parameters
Parameter
Required / Optional
Description
Data Type
"sending_domain"
Required
Specifies the domain for sending emails from the subaccount
string
"daily_send_limit"
Required
Sets the daily email sending cap for the subaccount in terms of the number of emails
int
"approved"
Required
Indicates whether the subaccount is approved for sending emails, with true for approved and false for unapproved status
boolean
Response Definition
Response Item
Description
Data Type
"user_id"
The unique identifier associated with the user who owns the subaccount.
int
"sending_domain"
The email domain used for sending emails through the subaccount.
string
"subaccount_id"
The unique identifier assigned to the subaccount.
string
"dns_value"
The verification value used for DNS configuration to authenticate the subaccount.
string
"dns_validation_status"
Indicates whether the DNS validation was successfully completed (true or false).
boolean
"dkim_value"
The DKIM (DomainKeys Identified Mail) public key value used for email authentication.
string
"dkim_validation_status"
Indicates whether the DKIM validation was successfully completed (true or false).
boolean
"spf_value"
The SPF (Sender Policy Framework) record used for email authentication.
string
"spf_validation_status"
Indicates whether the SPF validation was successfully completed (true or false).
boolean
"daily_send_limit"
The maximum number of emails the subaccount can send per day.
int
"approved"
Indicates whether the subaccount is approved for sending emails (true or false).
boolean
"reputation"
The reputation score of the subaccount, typically used to measure email sending quality.
int
"sent_monthly"
The number of emails sent from the subaccount in the past month.
int
"sent_weekly"
The number of emails sent from the subaccount in the past week.
int
"sent_total"
The total number of emails ever sent from the subaccount.
int
"name"
The name assigned to the subaccount.
string
"created_at"
The date and time when the user's account was created
date-time
"management_company_user_id"
The unique identifier of the management company associated with the subaccount.
