Docs
Email Accounts

Set account tags

Replace an account's tag set (assign + remove)

PUT
/v2/workspaces/{workspaceId}/accounts/{id}/tags

Path Parameters

idnumber
workspaceIdnumber

Request Body

tagsarray<string>

Full desired tag-name set for the account (max 25). Empty clears all tags.

Response Body

curl -X PUT "https://lynx-api.trulyinbox.com/v2/workspaces/0/accounts/0/tags" \  -H "Content-Type: application/json" \  -d '{    "tags": [      "Sales",      "Q1 Campaign"    ]  }'
{
  "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"
  }
}

Create workspace tagPOST

Create a workspace tag

Get Microsoft consent URLGET

Get the Microsoft admin-consent URL Microsoft-only first step. A tenant administrator opens this URL in a browser; the redirect returns a `tenantId` and `state` to POST back to this collection. Google tenants skip this step and POST an `adminEmail` directly. Pass `domain` (the customer's Microsoft domain or tenant GUID) to pin the prompt to that tenant and get its `tenantId` back here, so you do not have to rely on the admin reading it to you; an unresolvable domain returns 422 rather than silently falling back to the generic prompt.