Delete Subaccount

Overview

The "Delete Subaccount" API provides Agents 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

MethodEndpointDescription
DELETEv2023.07.31/emails/subaccountDeletes an existing subaccount

Response Definition

Response ItemDescriptionData Type
"user_id"The unique identifier for Supplierint
"sending_domain"The domain used for sending emailsstring
"subaccount_id"A unique subaccount identifier associated with the userstring
"dns_value"A DNS verification value used to verify domain ownershipstring
"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 authenticationstring
"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 emailsstring
"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 dayint
"approved"Indicates whether the user is approved (true) to send emails or not (false)boolean
"reputation"A numerical value representing the sender's reputationint
"sent_monthly"The number of emails sent in the current monthint
"sent_weekly"The number of emails sent in the current weekint
"sent_total"The total number of emails sentint
"name"The name or identifier of the subaccountstring
"created_at"The date and time when the user's account was createddate-time
"first_sent_at"The date and time when the first email was sent by the userdate-time
"mc_user_id"The unique identifier for Supplierint

Sample Request

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