Contacts

Add a volunteer

Add one contact to the roster. Blocked with validation_error when the account is already at its plan's volunteer limit (domain/volunteerCap.ts, the same rule the dashboard enforces). Requires contacts:write.

post/api/v1/contacts

Request

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

Request body

full_namestring required

Display name, shown on the roster and in reminder text. Required.

first_namestring nullable

First name, or null/omit if not recorded separately.

last_namestring nullable

Last name, or null/omit if not recorded separately.

email_addressstring email nullable

Email address reminders may be sent to, or null/omit.

mobile_phonestring nullable

Mobile phone number, used for SMS reminders. Accepts E.164 (+15125550100) or a plain 10-digit US/Canada number; normalized to E.164 on save. Send null or "" to clear it.

land_phonestring nullable

Landline phone number (not SMS-capable, informational only), or null/omit.

group_idinteger nullable

Id of an existing group on this account to file the contact under, or null for no group. Must reference a group already owned by this account.

notesstring nullable

Free-text notes about the contact.

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

{
  "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.",
  "consent_attested": true
}

Response

The created contact.

idnumber required

Contact id.

full_namestring required

Display name, shown on the roster and in reminder text.

first_namestring nullable required

First name, or null if not recorded separately.

last_namestring nullable required

Last name, or null if not recorded separately.

email_addressstring nullable required

Email address reminders may be sent to, or null.

mobile_phonestring nullable required

Mobile phone in E.164 format, used for SMS reminders, or null.

land_phonestring nullable required

Landline phone number (not SMS-capable, informational only), or null.

group_idnumber nullable required

Id of the group this contact belongs to, or null.

group_namestring nullable required

Display name of the group, or null when ungrouped.

notesstring nullable required

Free-text notes about the contact, or null.

created_atnumber required

Epoch milliseconds (UTC) the contact was created.

Example response

{
  "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.