Update Subaccount

Overview

Update Subaccount allows partners to modify the settings of an existing Mandrill subaccount associated with their partner account. This enables adjustments to the sending domain, email limits, and approval status, ensuring flexibility and control over email configurations.

Endpoints Available

MethodEndpointDescription
PUTv2024.07.31/emails/subaccountUpdate an existing subaccount’s settings, including sending domain, send limits, and approval status.

Body Parameters

ParameterRequired / OptionalDescriptionData Type
"sending_domain"RequiredThe email-sending domain associated with the subaccount.string
"daily_send_limit"RequiredThe maximum number of emails that can be sent daily.int
"approved"RequiredIndicates whether the subaccount is approved for sending emails, with true for approved and false for unapproved status.boolean

Response Definition

Response ItemDescriptionData 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) 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 dayint
"approved"Indicates whether the user is approved (true) to send emails or not (false).boolean
"management_company_user_id"The unique identifier of the management company associated with the subaccount.int

Sample Request

curl --request PUT \
     --url https://api.ciiruspartners.com/v2024.07.31/emails/subaccount \
     --header 'Content-Type: application/json' \
     --header 'Authorization: Basic {APIUsername:APIPassword}' \
     --data '
{
  "approved": true,
  "sending_domain": "[email protected]",
  "daily_send_limit": 6900
}
'

Sample Response

{
  "user_id": 42330,
  "sending_domain": "testdomain.com",
  "subaccount_id": "subaccount-42330-partner-api",
  "dns_value": "mandrill_verify.ZVC6Iwsy1Be5ejuELRvOoA",
  "dns_validation_status": false,
  "dkim_value": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCrLHiExVd55zd/IQ/J/mRwSRMAocV/hMB3jXwaHH36d9NaVynQFYV8NaWi69c1veUtRzGt7yAioXqLj7Z4TeEUoOLgrKsn8YnckGs9i3B3tVFB+Ch/4mPhXWiNfNdynHWBcPcbJ8kjEQ2U8y78dHZj1YeRXXVvWob2OaKynO8/lQIDAQAB;",
  "dkim_validation_status": false,
  "spf_value": "v=spf1 include:spf.mandrillapp.com ?all",
  "spf_validation_status": true,
  "daily_send_limit": 6900,
  "approved": false,
  "management_company_user_id": 42330
}