Rename a list

Rename a list of any kind, and optionally rewrite its description (omit it to keep the current one). A name another list in the workspace already has answers 409.

PATCHhttps://app.trygtm.com/api/v1/lists/{list_id}

Scope: write
MCP tool: rename_list

Path parameters

list_idstringrequired: The list's id, from list_lists.

Headers

Idempotency-Keystringoptional: A key unique to this write, up to 255 characters. A retry carrying the same key returns the first response instead of running again. Kept for 24 hours.

Body

namestringrequired: The new name.
descriptionstring | nulloptional: The new description. Omit to keep the current one; null or empty clears it.

Request

curl -X PATCH https://app.trygtm.com/api/v1/lists/8f2a91c4-6d1e-4c0a-9a57-2f3b1c7e9d10 \
  -H "Authorization: Bearer $TRYGTM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q4 logistics leaders"
  }'

Response

{
  "data": {
    "id": "5e6f7a8b-1c2d-4e3f-9a0b-1c2d3e4f5a6b",
    "name": "Trade show — Sept, booth scans",
    "description": "People who stopped at the booth."
  }
}