Overview

The "Retrieve Subaccount" function 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	v2023.07.31/emails/subaccount	Retrieves associated Mandrill subaccount information

Response Definition

Response Item	Description	Data Type
`"user_id"`	The unique identifier for Supplier	int
`"sending_domain"`	The domain used for sending emails	string
`"subaccount_id"`	A unique subaccount identifier associated with the user	string
`"dns_value"`	A DNS verification value used to verify domain ownership	string
`"dns_validation_status"`	Indicates whether DNS validation is successful (true) or not (false)	boolean
`"dkim_value"`	The DKIM (DomainKeys Identified Mail) value used for email authentication	string
`"dkim_validation_status"`	Indicates whether DKIM validation is successful (true) or not (false)	boolean
`"spf_value"`	The SPF (Sender Policy Framework) value defining authorized sources to send emails	string
`"spf_validation_status"`	Indicates whether SPF validation is successful (true) or not (false)	boolean
`"daily_send_limit"`	The maximum number of emails that can be sent per day	int
`"approved"`	Indicates whether the user is approved (true) to send emails or not (false)	boolean
`"reputation"`	A numerical value representing the sender's reputation	int
`"sent_monthly"`	The number of emails sent in the current month	int
`"sent_weekly"`	The number of emails sent in the current week	int
`"sent_total"`	The total number of emails sent	int
`"created_at"`	The date and time when the user's account was created	date-time
`"first_sent_at"`	The date and time when the first email was sent by the user	date-time
`"mc_user_id"`	The unique identifier for Supplier	int

Sample Request

curl --request GET \
     --url https://api.ciiruspartners.com/v2023.07.31/emails/subaccount

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,
  "created_at": "2022-08-11T12:00:24.61804",
  "first_sent_at": "2022-08-11T12:06:02.98946",
  "mc_user_id": 42330
}