Docs
Email Accounts

Bulk email account status

Get status for up to 50 accounts in one call

POST rather than GET because the id list can exceed a practical query-string length. Results are ordered to match the requested ids; ids that do not exist in this workspace are reported in notFound rather than failing the request.

POST
/v2/workspaces/{workspaceId}/accounts/bulk-status

Path Parameters

workspaceIdnumber

Request Body

accountIdsarray<number>

Account ids to read. Max 50 per request.

Response Body

curl -X POST "https://lynx-api.trulyinbox.com/v2/workspaces/0/accounts/bulk-status" \  -H "Content-Type: application/json" \  -d '{    "accountIds": [      1,      2,      3    ]  }'
{
  "data": {
    "accounts": [
      {
        "id": 0,
        "emailAddress": "string",
        "senderName": "string",
        "provider": "string",
        "authMethod": "string",
        "status": "string",
        "accountState": "string",
        "statusBucket": "string",
        "sendCheckFailed": true,
        "receiveCheckFailed": true,
        "structuredStatus": {},
        "warmupStatus": "string",
        "warmupPausedAt": "2019-08-24T14:15:22Z",
        "warmupPausedReason": "string",
        "throttleReason": "string",
        "cooldownUntil": "2019-08-24T14:15:22Z",
        "warmupMinLimit": 0,
        "warmupMaxLimit": 0,
        "warmupCurrentLimit": 0,
        "warmupRampupDay": 0,
        "warmupStrategy": "string",
        "timezone": "string",
        "poolTier": "string",
        "deliverabilityRate": 0,
        "spfData": {},
        "dkimData": {},
        "dmarcData": {},
        "mxRecordData": {},
        "dnsCheckedAt": "2019-08-24T14:15:22Z",
        "setupScore": 82,
        "inboxPlacementScore": 0,
        "lastVerifiedAt": "2019-08-24T14:15:22Z",
        "pushNotificationsActive": true,
        "createdAt": "2019-08-24T14:15:22Z",
        "source": "string",
        "dwdWorkspaceId": 0,
        "partnerIntegrationId": 0,
        "domainRegisteredAt": "2019-08-24T14:15:22Z",
        "mailboxCreatedAt": "2019-08-24T14:15:22Z",
        "warmupStartDate": "2019-08-24T14:15:22Z",
        "replyRate": 0,
        "warmupPreference": "string",
        "contentIndustry": "string",
        "contentTopics": [
          "string"
        ],
        "contentLanguage": "string",
        "blacklistedAt": "2019-08-24T14:15:22Z",
        "blacklistSource": "string",
        "todaySent": 0,
        "todayReceived": 0,
        "sevenDaySent": 0,
        "sevenDayReceived": 0,
        "tags": [
          {
            "id": 0,
            "name": "string",
            "color": "string"
          }
        ],
        "activeBulkJobId": "string",
        "activeImportId": "string"
      }
    ],
    "notFound": [
      0
    ]
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Rate limit statusGET

Get this key’s rate-limit status Requests consumed and remaining in the current one-minute window, for the read (GET), write (POST/PATCH/PUT/DELETE) and bulk (batched endpoints) buckets, plus the plan tier being applied. This call itself counts toward the read bucket.

Assign or unassign tags in bulkPOST

Assign and/or unassign tags across multiple accounts One route covers both directions: `addTags` are applied to every selected account (created on demand if the tag name is new), `removeTags` are stripped from every selected account. Both are optional - send either, or both in the same call. Tags are addressed by NAME, not id. Ids outside the caller workspace are filtered out before anything is applied, so `accounts` in the response can be lower than the number of ids sent.