Developers
Open Swarmhit
DocumentationAPI Reference
Lists
PATCH
/lists/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created under Settings → API & Webhooks.

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

Previous Page

Create a workspace POST

Creates a workspace inside the connected organization. Optionally grant it sender seats from the organization pool with `seatAllocation`. Requires the connected workspace to be an organization (otherwise `403`).