v1

latestOpenAPI 3.0.02026-08-062438369.6 KB

Users

Create / Update User

Upserts a user by email address. If no user with the given email exists, a new user is created and a 201 response is returned. If a user with that email already exists, their record is updated and a 200 response is returned. Note: if the user belongs to an organization other than your own organization or one of its child organizations, their core profile fields (name, email, password) cannot be modified — only their membership role within your organization can be adjusted.

post/users

Request body

first_namestring required

The first name of the user

last_namestring required

The last name of the user

emailstring required

The email for the user

passwordstring

The user's password. Must be at least 10 characters and include letters and numbers.

orgstring

Optional. The slug of the organization to assign the user to. Defaults to your partner organization. Must be your own organization or one of its child organizations.

invite_codestring

Optional. The invitation code for the target organization. When supplied, this takes precedence over the org field and determines which organization the user is added to.

birthdaystring YYYY-MM-DD required

The birthday for the user

gender'M' | 'F' | 'N' required

The gender for the user

phonestring

Optional. The phone number for the user.

role'VOLUNTEER' | 'ORGANIZER' | 'ADMIN'

Optional. The user's role within your organization. Defaults to VOLUNTEER when not provided. Possible values: VOLUNTEER — standard volunteer member; ORGANIZER — can create and manage projects and events; ADMIN — organization administrator with full management access.

Example request

{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "password": "password1234",
  "org": "vomo",
  "invite_code": "vomoinvitationcode",
  "birthday": "1975-12-01",
  "gender": "M",
  "phone": "555-867-5309",
  "role": "VOLUNTEER"
}

Response

A user with the provided email already existed and has been updated. Returns the updated user record.

codestring

messagestring

Example response

{
  "code": "200",
  "message": "User updated.",
  "data": {
    "type": "user",
    "id": "1",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "email": "person@vomo.org",
    "address": "610 Elm St, McKinney, TX 75069, USA",
    "phone": "1234567890",
    "birthday": "1975-12-01",
    "gender": "M",
    "updated_at": "2016-03-07T07:49:41+00:00",
    "created_at": "2016-03-07T07:49:41+00:00",
    "user_status": "VERIFIED",
    "membership_status": "ACCEPTED",
    "membership_role": "VOLUNTEER"
  }
}