Contacts

Replace a schedule's roster

Assign contacts to a schedule. REPLACES the schedule's whole roster (matches the dashboard's save-the-form semantics) — send the complete desired set of contact ids, not a delta. Every id must belong to this account or the whole request is rejected. Requires contacts:write.

post/api/v1/schedules/{id}/roster

Request

  • Base URL: https://volunteerreminder.com
  • URL: https://volunteerreminder.com/api/v1/schedules/{id}/roster
  • Auth: HTTP bearer

Path parameters

idinteger required

Schedule id.

Example:55

Request body

contact_idsinteger[] required

The complete roster for this schedule — REPLACES any existing assignment (not additive). Pass an empty array to clear the roster. Every id must belong to this account.

Example request

{
  "contact_ids": [
    101,
    102,
    103
  ]
}

Response

The roster after the change.

schedule_idnumber required

The schedule the roster was assigned to.

contact_idsnumber[] required

The schedule's roster after this change (deduplicated).

Example response

{
  "schedule_id": 55
}

Changes

No recorded changes to this operation across all 1 revision of this API.