For the complete documentation index, see llms.txt. This page is also available as Markdown.

Remove users from sites

This endpoint removes one or more users from one or more sites. It uses an identical body to the assign endpoint, and supports single or bulk input.

Endpoint Description:

  • Endpoint: POST /api/sites/unassign/

  • Base URL: https://api.vomevolunteer.com

API specification:

  • user_ids (array): List of Vome IDs.

  • site_ids (array): List of site ids.

  • user_id (string): Single Vome ID; normalized into user_ids.

  • site_id (string): Single site id; normalized into site_ids.

Authorization:

Requests to this endpoint must include an API-KEY in the header for authentication.

headers = {
    "API-KEY": "your_unique_api_key_here"
}
response = requests.post("https://api.vomevolunteer.com/api/sites/unassign/", headers=headers)

Example Request Payload:

{
    "user_ids": ["<VOME_ID_1>", "<VOME_ID_2>"],
    "site_ids": ["<SITE_ID_A>", "<SITE_ID_B>"]
}

Response Structure:

Note: removed is the count of membership rows deleted for that user. As with assign, unknown users are returned in skipped_user_ids and are not fatal; only unknown sites produce a 400.

Last updated