Overview

Delete Subaccount provides Partners with the capability to remove an associated subaccount within their CiiRUS platform. This endpoint allows the agent to delete a subaccount and its associated settings and configurations.

Endpoints Available

Method	Endpoint	Description
DELETE	v2024.07.31/emails/subaccount	Deletes an existing subaccount

Response Definition

Response Item	Description	Data Type
`"user_id"`	The unique identifier of the user managing the subaccount.	int
`"sending_domain"`	The email sending domain associated with the subaccount.	string
`"subaccount_id"`	The unique identifier assigned to the subaccount.	string
`"dns_value"`	The DNS verification value for domain authentication.	string
`"dns_validation_status"`	Indicates whether DNS validation is successful (`true`) or not (`false`).	boolean
`"dkim_value"`	The DKIM (DomainKeys Identified Mail) configuration for the subaccount.	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 subaccount is approved for email sending.	boolean
`"reputation"`	A numerical value representing the sender's reputation.	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 or identifier of the subaccount.	string
`"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
`"management_company_user_id"`	The unique identifier of the management company associated with the subaccount.	int

Sample Request

curl --request DELETE \
     --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": 420,
  "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
}