Update a shortlist

PATCH https://api.vamotalent.ai/v2/shortlists/{id}
Access
Authenticated
shortlist:update
Cost
Free
Rate limit
30 / minute per account
Quota
None

Rename, edit, pin/unpin, or archive/unarchive a shortlist.

Path parameters

  • id string required
    max 16 chars

Request body UpdateShortlistRequest application/json

  • name string

    Rename the list.

    min 1 chars, max 80 chars
  • description string | null

    Change the description, or send null to clear it.

    max 280 chars
  • pinned boolean

    Pin or unpin the list.

  • archived boolean

    Archive or unarchive the list. Archiving hides it from the default listing without deleting anything.

Responses

The updated shortlist

  • id string required

    The shortlist id.

  • name string required

    The list name.

  • kind string required

    What kind of list this is: `project` for a list linked to a project you can read, `freestanding` for every other list. Seeing `project` needs project:read: without it a list linked to a project reads `freestanding` like any other. An API key or a connected AI client does not hold project:read.

    freestandingprojectpipeline
  • description string | null required

    Free-text description. Null when none.

  • ownerId string | null required

    The member or API key that owns the list, as an actor id. Null when it has no individual owner.

  • pinned boolean required

    Whether the list is pinned for quick access.

  • archivedAt string | null required

    When the list was archived, as an ISO 8601 instant. An archived list is hidden from the default listing but keeps its members and sequences. Null while active.

  • createdAt string required

    When the list was created, as an ISO 8601 instant.

  • agentId string | null required

    The managed agent that owns this list, when one does. The list is yours either way; this only says who keeps it up to date.

  • stats object required

    Member and sequence counts for this list.

    • members integer required

      How many contacts are on this list.

    • sequences integer required

      How many outreach sequences are attached to it.