NUnureply
Email Accounts

Update email account settings

Update configuration for an existing email account, including sender name, daily limits, warmup settings, and tracking domain.

patch/v3/user-api/accounts/{id}

Request

  • Base URL
    https://api.nureply.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared. Required headers: x-personal-api-key

Path parameters

idstring required

Email account ID

Headers

x-personal-api-keystring required

API Key from Dashboard

Request body

senderNamestring

Display name for the sender

dailySendingLimitinteger

Maximum emails per day

isSlowStartEnabledboolean

Enable gradual increase of sending limits (slow start feature)

trackingDomainstring

Custom tracking domain

signaturestring

Email signature HTML

tagsstring[]

Account organization tags

isDisabledboolean

Disable/enable the account

Example request

{
  "senderName": "John Doe - Updated",
  "dailySendingLimit": 75,
  "trackingDomain": "track.example.com",
  "signature": "Best regards,<br>John Doe",
  "warmupDetails": {
    "maximumWarmUpPerDay": 30,
    "minimumWarmUpStartEmails": 5,
    "warmUpStableDays": 7,
    "warmUpPerDayRemaining": 30,
    "warmUpStartDate": "2023-10-20T10:30:35.624Z"
  },
  "tags": [
    "sales",
    "priority"
  ]
}

Response

messagestring required

Example response

{
  "message": "Updated email account successfully",
  "data": {
    "_id": "653a2b0bf5444e11e5cdd1ce",
    "address": "sender@example.com",
    "senderName": "John Doe",
    "imapServer": "imap.example.com",
    "imapPort": 993,
    "smtpServer": "smtp.example.com",
    "smtpPort": 465,
    "security": "TLS",
    "dailySendingLimit": 50,
    "dailySendingLimitRemaining": 35,
    "emailsSentToday": 15,
    "trackingDomain": "track.example.com",
    "trackingDomainStatus": "active",
    "accountStatus": "ready",
    "sendingStatus": "ready",
    "accountHealth": 95,
    "warmUpDetails": {
      "maximumWarmUpPerDay": 30,
      "minimumWarmUpStartEmails": 5,
      "warmUpStableDays": 7,
      "warmUpPerDayRemaining": 30,
      "warmUpStartDate": "2023-10-20T10:30:35.624Z"
    },
    "dkimDetails": {
      "status": "pass",
      "message": "DKIM authentication passed"
    },
    "spfDetails": {
      "status": "pass",
      "message": "DKIM authentication passed"
    },
    "dmarcDetails": {
      "status": "pass",
      "message": "DKIM authentication passed"
    },
    "tags": [
      "sales",
      "outbound"
    ],
    "signature": "Best regards,<br>John Doe",
    "createdAt": "2023-10-26T10:30:35.624Z",
    "updatedAt": "2023-10-26T10:30:35.624Z",
    "id": "653a2b0bf5444e11e5cdd1ce"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.