API referenceAccounts
PATCH
/accounts/warmup

JavaScript SDK: swarmhit.accounts.warmup.update(params)

Sets the acting workspace's own settings (the organization's, without the header). Send only the fields to change: the others keep the value in force, so a workspace that follows its organization starts from the organization's values. A workspace's own settings replace its organization's as a whole; send {"inherit": true}, alone, to drop them and follow the organization again.

autoStart decides whether an account starts warming up on its own, once, when it is connected for the first time: never, new (when it looks new, by newAccount) or all. Turning it on never slows accounts that are already connected; start or stop one by hand with PATCH /accounts/{id}/limits. A value out of range is refused, never clamped: 400 with code: invalid-warmup and every reason in details.errors.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The fields to change (at least one). {"inherit": true}, alone, drops the workspace's own settings so it follows its organization again.

Properties1 <= properties

Response Body

application/json

application/json

application/json

curl -X PATCH "https://example.com/accounts/warmup" \  -H "Content-Type: application/json" \  -d '{    "enabled": true,    "autoStart": "all",    "ramp": {      "start": 10,      "step": 5,      "everyDays": 3    }  }'
{  "data": {    "workspaceId": "string",    "isOrganization": true,    "source": "workspace",    "enabled": true,    "autoStart": "never",    "newAccount": {      "maxConnections": 1,      "noPreviousActivity": true    },    "ramp": {      "start": 1,      "step": 1,      "everyDays": 1    }  }}

Change a sender's limits PATCH

**JavaScript SDK:** [`swarmhit.accounts.limits.update(accountId, params)`](/smart-api/sdk/methods#accounts.limits) Send only the caps to change, by key; the others keep their value. Each value is saved as a whole number within the range GET returns for the sender's plan: a value above `max` is saved as `max`, one below 0 as 0, and a fraction is rounded. Send `null` to drop the sender's own value: the cap then follows its plan's `default` again, also when the plan or its default changes later. The response has the same shape as GET, with the values saved, so read `limit` to see what was applied. 400 with `code: invalid-limit` for an empty body, an unknown key, or a value that is neither a number nor null. `warmup` sets its own LinkedIn warm-up, alone or with caps: `inherit` (its workspace's warm-up settings decide), `off` (full speed now), `on` (start now on the workspace's ramp, even when those settings are off) or `custom` (start now on its own `ramp`). An account already warming keeps its day. 400 with `code: invalid-warmup`, and every reason in `details.errors`, for a setting that can't be taken; nothing is saved then, caps included.

Approve a comment draft POST

**JavaScript SDK:** [`swarmhit.pendingComments.approve(pendingCommentId, params?)`](/smart-api/sdk/methods#pendingComments) Approve a draft (optionally replacing its text) so the campaign posts it on its next run. An unknown id is a 400 with `code: warning-pending-comment-not-found`, and a draft that is no longer `pending` a 400 with `code: warning-pending-comment-decided`.