Contacts

Add volunteers in bulk

Add up to 200 contacts in one call. ALL-OR-NOTHING: if the batch would push the account's active-volunteer count past its plan's limit, or any contact references a group_id that doesn't belong to this account, NOTHING is created and a validation_error names the limit, the account's current count, or the bad group id. Requires contacts:write.

post/api/v1/contacts/bulk

Request

  • Base URL: https://volunteerreminder.com
  • URL: https://volunteerreminder.com/api/v1/contacts/bulk
  • Auth: HTTP bearer

Request body

consent_attestedboolean

Required to be true when any contact in this request has a mobile_phone. By setting it you affirm: "I confirm these volunteers gave their mobile number to our organization and agreed to receive shift reminder texts from us, sent through VolunteerReminder, and that I can show how they agreed if asked." The affirmation is recorded with your API key id and the time, and is what we produce if a carrier audits our messaging. Omit for email-only contacts.

Example request

{
  "consent_attested": true,
  "contacts": [
    {
      "full_name": "Ann Adams",
      "first_name": "Ann",
      "last_name": "Adams",
      "email_address": "ann@example.org",
      "mobile_phone": "+15125550100",
      "land_phone": "+15125550199",
      "group_id": 12,
      "notes": "Prefers Saturday shifts."
    }
  ]
}

Response

The created contacts.

Example response

{
  "created": [
    {
      "id": 4021,
      "full_name": "Ann Adams",
      "first_name": "Ann",
      "last_name": "Adams",
      "email_address": "ann@example.org",
      "mobile_phone": "+15125550100",
      "land_phone": "+15125550199",
      "group_id": 12,
      "group_name": "Sunday greeters"
    }
  ]
}

Changes

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