Create Member

Creates a new organization member

Request Details

body Parameters

Field	Type	Required	Description
firstName	string	Yes	Member's first name
lastName	string	Yes	Member's last name
email	string	Yes	Member's email address
organizationId	string	Yes	ID of the organization this member belongs to
locations	array MemberLocation	Yes	List of locations the member is assigned to, along with their role at each location
isPrimary	boolean	Yes	Indicates whether the member is the primary organization holder or main contact for the organization
isActive	boolean	No	Indicates whether the member is currently active within the organization
settings	object MemberSettings	Yes	Member-specific settings such as profile picture and default location

Sample Request & Response

POST

/v1/members

Sample Request

Headers:

{
  "Authorization": "Bearer <YOUR_API_KEY>"
}

Body:

{
  "firstName": "example_string",
  "lastName": "example_string",
  "email": "example_string",
  "organizationId": "example_string",
  "locations": [
    {
      "locationId": "example_string",
      "role": [
        "admin",
        "editor",
        "viewer"
      ]
    }
  ],
  "isPrimary": true,
  "isActive": true,
  "settings": {
    "password": "example_string",
    "profilePictureUrl": "example_string"
  }
}

Sample Response (201)

{
  "id": "example_string",
  "createdAt": "2025-07-26T12:00:00Z",
  "updatedAt": "2025-07-26T12:00:00Z",
  "firstName": "example_string",
  "lastName": "example_string",
  "email": "example_string",
  "organizationId": "example_string",
  "locations": [
    {
      "locationId": "example_string",
      "role": [
        "admin",
        "editor",
        "viewer"
      ]
    }
  ],
  "isPrimary": true,
  "isActive": true,
  "settings": {
    "profilePictureUrl": "example_string"
  }
}