Docs
Email Accounts

Get email account

Get a single email account

GET
/v2/workspaces/{workspaceId}/accounts/{id}

Path Parameters

workspaceIdnumber
idnumber

Response Body

curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces/0/accounts/0"
{
  "data": {
    "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"
  },
  "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"
  }
}

Get a Microsoft single-mailbox consent linkGET

Connect ONE Microsoft mailbox without running your own OAuth app. Give the mailbox address (`email`) you want connected; the connection completes only if the Microsoft account that grants consent resolves to that address, which is what confirms ownership. The returned link is single-use and expires in 30 minutes - send it to the mailbox owner to open when they are ready. Once they finish they land on a result page carrying `partnerConnectStatus` (and, on failure, `partnerConnectReason`); poll GET .../accounts to confirm the mailbox connected. Warmup is enabled automatically on the new account, subject to plan capacity.

Delete an email accountDELETE

Permanently removes the account and its warmup history. This cannot be undone - use the disconnect endpoint to stop warmup while keeping the data. Returns 204 with no body.