Skip to content

Docs

Get API key

Lists

Rename a list

PATCH/lists/{listId}

Gives a list a new name. Two lists can’t share a name.

Try itSend a real request with your API key

API key listId path Body JSON

This changes your workspace, as the same change in the app would. Your key stays in this page and goes only to Salesteam.

Path

listIdstringRequired
The list.

Headers

Idempotency-Keystring
Any unique value up to 255 characters, like a UUID. The request runs once; repeats within 24 hours get the first answer, with Idempotent-Replayed: true. Up to 255 characters.

Body

namestringRequired
Up to 100 characters.

Answer

200 OK The list, renamed.

dataListRequired
Inside it
- idstringRequired
  List ID.
- namestringRequired
- createdAtstring · date-timeRequired
- leadsintegerRequired
  People in the list.
- campaignsarray of objectRequired
  Campaigns that take people from this list.
  Each item
  - idstringRequired
  - namestringRequired
  - statusstringRequired
    draft: not launched. active: running. paused: stopped by the owner. completed: finished. One of draft, active, paused, completed.

Errors

400 Bad requestinvalid_request invalid_json duplicate_in_request
401 Unauthorizedunauthorized
404 Not foundnot_found not_in_campaign
409 Conflictconflict idempotency_in_progress workspace_busy campaign_finished campaign_without_list tag_limit lead_has_history campaign_not_launched campaign_cannot_resume ambiguous_email
413 Too largetoo_large
415 Wrong content typeunsupported_media_type
422 Can’t processidempotency_key_reused
429 Too many requestsrate_limited
500 Server errorserver_error

Every error has the same shape. See Errors.

PATCH /lists/{listId}

curl -X PATCH "https://app.salesteam.dev/api/v1/lists/LIST_ID" \
  -H "Authorization: Bearer $SALESTEAM_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "Tier 1 founders (Q1)"
}'

const response = await fetch("https://app.salesteam.dev/api/v1/lists/LIST_ID", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.SALESTEAM_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "name": "Tier 1 founders (Q1)"
  }),
});
console.log(response.status, await response.json());

import os, uuid
import requests

response = requests.patch(
    "https://app.salesteam.dev/api/v1/lists/LIST_ID",
    headers={"Authorization": f"Bearer {os.environ['SALESTEAM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
    json={
        "name": "Tier 1 founders (Q1)",
    },
)
print(response.status_code, response.json())

200 answer

{
  "data": {
    "id": "list_7Qm2xT9a",
    "name": "Founders Q4",
    "createdAt": "2026-11-12T09:00:00.000Z",
    "leads": 1,
    "campaigns": [
      {
        "id": "cmp_7Qm2xT9a",
        "name": "Founders Q4",
        "status": "draft"
      }
    ]
  }
}