Accounts
PATCH
/accounts/warmup

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    }  }}