API referenceLists
PATCH
/lists/{id}

JavaScript SDK: swarmhit.lists.update(listId, params)

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/lists/string" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "data": {    "id": "string",    "name": "string",    "color": "string",    "leadCount": 0,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Remove a lead from a list DELETE

**JavaScript SDK:** [`swarmhit.lists.leads.remove(listId, leadId)`](/smart-api/sdk/methods#lists.leads) Takes the lead off the list; the lead itself is kept. If the list is a campaign's own list (the campaign's `listId`), the lead is also removed from that campaign. 404 only for an unknown list: a lead that is not on it still answers 200.

Use a domain you already own POST

**JavaScript SDK:** [`swarmhit.managedDomains.create(params)`](/smart-api/sdk/methods#managedDomains) Use a domain the workspace already owns for bought mailboxes, instead of buying one: nothing is charged for the domain, only its mailboxes. Its DNS moves to Swarmhit: set the two `connection.nameservers` at the domain's registrar, replacing `connection.currentNameservers` (empty for a minute when our mail supplier is slow to answer: read the domain again). Its website records (A/AAAA at the root, `www`) are copied to its new DNS (`connection.websiteRecords`), so the site keeps working; nothing else is copied, so subdomains, other records and any email it has today stop working. The domain then connects on its own (`connection.state`: `nameservers` → `setting_up` → `ready`). Set the nameservers within about 12 hours: a pair not seen by then is replaced by a new one (`connection.nameserversChangedAt`, webhook `managed_domain.action_required` with `reason: nameservers_changed`). Follow it with GET /managed-domains/{id} or the `managed_domain.*` webhooks. Once `canAdd` is true, add mailboxes with a domain entry `{ name, existing: true, mailboxes }` in POST /mailbox-orders/quote. Nameservers not changed within 7 days: `expired`, add it again later. A domain another account had live here before needs support (`domain-taken`). Needs the managed mailboxes feature, billing rights (the key's creator) and a payment method on file. At most 5 domains connect at once, and 5 adds a minute.