Overview

Retrieve Subaccount provides partners with the ability to retrieve information about their associated Mandrill subaccount, which is a fundamental component of email communication. By utilizing this function, partners can access and manage specific subaccount details, ensuring streamlined control and integration of email services within their systems.

Endpoints Available

Method	Endpoint	Description
GET	v2024.07.31/emails/subaccount	Retrieves associated Mandrill subaccount information

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) 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) value defining authorized sources to send emails.	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 subaccount was created.	date-time
`"first_sent_at"`	The date and time when the subaccount sent its first email.	date-time
`"management_company_user_id"`	The unique identifier of the management company associated with the subaccount.	int

Sample Request

curl --request GET \
     --url https://api.ciiruspartners.com/v2024.07.31/emails/subaccount \
     --header 'Authorization: Basic {APIUsername:APIPassword}' \

Sample Response

{
  "user_id": 42330,
  "sending_domain": "ciirus.com",
  "subaccount_id": "subaccount-42330-partner-api",
  "dns_value": "mandrill_verify.1LJTwMFrjPZ7EY2KX1_D_V",
  "dns_validation_status": true,
  "dkim_value": "v=DKIM1; k=rsa; p=L9TkQB1gZJ2cZnSe1Kf/dUM3LShVe9jtiRhzlEruVNbZvBtWeSj6+D9XKm/19D2NO5oyG4z3btaJqYbNZl+EJalB07eZy6tzVTeKfQs62crRbBnvUZbP9iLQlSbRIBjraPe9Ij5aPhQWdRlNBbUWbVjoVH39G9Mz2jbJlqG1e8h4r7gBDAQUECAHw;",
  "dkim_validation_status": true,
  "spf_value": "v=spf1 include:spf.mandrillapp.com ?all",
  "spf_validation_status": true,
  "daily_send_limit": 69,
  "approved": true,
  "reputation": 0,
  "sent_monthly": 1,
  "sent_weekly": 1,
  "sent_total": 36,
  "name": "subaccount-42330-partner-api",
  "created_at": "2022-08-11T12:00:24.61804",
  "first_sent_at": "2022-08-11T12:06:02.98946",
  "management_company_user_id": 42330
}