Create a shortlist

POST https://api.vamotalent.ai/v2/shortlists
Access
Authenticated
shortlist:create
Cost
Free
Rate limit
30 / minute per account
Quota
None

Create a shortlist. Duplicate live names are a conflict, except with projectId: the list is linked to that project on create and its name is made unique server-side, so the call never 409s on a name.

Request body CreateShortlistRequest application/json

  • name string required

    The list name.

    min 1 chars, max 80 chars
  • description string

    An optional description of what the list is for.

    max 280 chars
  • projectId string

    Link the new list to this project as it is created. The name is then made unique for you ("Backend · Worth a closer look (2)") instead of failing on a duplicate, and a list of that name already linked to the project is returned rather than created twice. Needs project:update as well.

    max 16 chars

Responses

The created shortlist, or with projectId the one already linked under that name

  • 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.