RErecruitwithatlas
Lists

Add people to a list

Changed on

Adds people to a list. Adding is idempotent — person IDs already on the list are ignored and duplicates within personIds are collapsed, so the call still returns 200. A list holds at most 12,000 members; a request that would take it past that returns 422, as does a person ID that does not belong to your agency (including one that has since been merged into another person). Note: the list entityType (candidate or contact) is not validated against the people you add — any person in your agency can be added to any list.

post/api/v1/lists/{id}/members

Request

Path parameters

idstring uuid required

List ID

Example:3f1c9d2e-8a45-4c7b-9f01-2d6e5b4a7c31

Request body

personIdsstring[] required

Person IDs to add or remove (max 100 per request)

Example request

{
  "personIds": [
    "3f1c9d2e-8a45-4c7b-9f01-2d6e5b4a7c31"
  ]
}

Response

Members added

status'ok' required

Changes

  • cd4bc8bbd95eRevision changes
    • breaking

      removed the required property / from the response with the status

    • warning

      added the new candidate enum value to the / response property for the response status

    • warning

      added the new contact enum value to the / response property for the response status

    • warning

      added the new private enum value to the / response property for the response status

    • warning

      added the new public enum value to the / response property for the response status

    • warning

      added the new team enum value to the / response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property / to the response with the status

  • d7ef7f970d5bRevision changes
    • info

      endpoint added