Update an account

API referenceAccounts

From the Accounts API reference. Requests use the base URL https://app.warmerly.com/api/v1 and an API key, see Authentication.

text

PATCH /accounts/{id}

Updates settings on an existing account. Only send the fields you want to change. A few of the most commonly used fields:

Field	Type	Description
`displayName`	string	Friendly name shown in the dashboard.
`timezone`	string	IANA timezone for scheduling sends.
`notes`	string	Freeform notes shown in the dashboard.
`dailyCampaignLimit`	integer (0-1000)	Max campaign emails sent per day from this account.
`minWaitMinutes`	integer (0-1440)	Minimum wait between campaign emails from this account.
`slowRampEnabled`	boolean	Turns the slower campaign volume ramp on or off.
`dailyInboxPlacementTestLimit`	integer (0-100)	Daily limit on inbox placement tests for this account.
`warmupDailyLimit`	integer (1-500) or `null`	Per-mailbox ceiling on warmup emails per day. `null` removes it.
`senderFirstName` / `senderLastName`	string or `null`	Overrides the sender identity used in campaign merge fields.
`fromName`	string (max 80) or `null`	The name recipients see in the From header, for example your company. Empty or `null` falls back to first and last name. Does not change `{{senderFirstName}}`.
`signatureHtml`	string or `null`	Signature for outgoing campaign mail.
`replyToAddress`	valid email, `""` or `null`	Reply-to address for outgoing campaign mail. `""` clears it.
`trackingDomain`	string or `null`	A custom tracking hostname. It must be a bare hostname, and changing it resets its verification until the next DNS check.
`dkimSelector`	string or `null`	The DKIM selector to check first in DNS checks.
`smtpUser` / `imapUser`	valid email or `null`	Login identity override, for accounts connected with OAuth only (`400` otherwise).
`projectId`	string (UUID)	Moves the mailbox to another project, including one in another workspace. Needs `owner` or `admin` on both sides.

These are the only fields PATCH accepts. Any other field in the body is ignored without an error, so check the returned account to confirm a change landed. On the free sandbox mailbox (managedBy: "warmerly_sandbox") dailyCampaignLimit, minWaitMinutes, slowRampEnabled and dailyInboxPlacementTestLimit are refused with 400.

bash

curl -X PATCH https://app.warmerly.com/api/v1/accounts/3a6f9e2e-4b7a-4e9a-9b1d-6e3a2f8c1a10 \
  -H "X-Api-Key: wmv_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "dailyCampaignLimit": 45, "notes": "Ramping faster for Q3 push" }'

json

{
  "account": {
    "id": "3a6f9e2e-4b7a-4e9a-9b1d-6e3a2f8c1a10",
    "dailyCampaignLimit": 45,
    "notes": "Ramping faster for Q3 push"
  }
}

The response is the full account object (abridged above) with trackingCnameTarget added.

Was this page helpful?

Update an account

More from Accounts