Creates or updates a user

post

https://api.solidarity.tech/v1/users

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

User data

phone_number

string | null

required

string | null

first_name

string | null

last_name

string | null

preferred_language

string

second_language

string | null

chapter_id

integer | null

Primary chapter ID. Required for new users unless chapter_ids is provided.

chapter_ids

array of integers | null

Array of chapter IDs for multi-chapter membership. First element becomes primary if chapter_id not provided. Requires multi-chapter feature for more than one chapter.

chapter_ids

referred_by_user_id

integer | null

custom_user_properties

object | null

Custom property values keyed by internal_name. Use a string for single-value fields (text, number, radio, dropdown, single checkbox). Use an array of strings for Multiple Checkboxes fields (e.g. ["Option A", "Option B"]). Comma-separated strings are also accepted for Multiple Checkboxes (e.g. "Option A, Option B"). For Multiple Checkboxes, see append_custom_user_properties to control whether values are merged with or replace existing values.

append_custom_user_properties

boolean | null

Controls how Multiple Checkboxes custom properties are written. Defaults to true (union new values with existing values, the long-standing API behavior). Set to false to overwrite existing values, mirroring bulk update REPLACE mode. Has no effect on non-array field types.

add_tags

array of strings | null

add_tags

remove_tags

array of strings | null

remove_tags

donation_charge

object | null

Optional external donation charge to create

address

object | null

Optional address to create. We will attempt to geocode the address if latitude and longitude are not provided.

assessment

string | null

Assessment status key to set on the user (maps to classification)

sms_permission

boolean | null

call_permission

boolean | null

email_permission

boolean | null

timezone

string | null

IANA timezone identifier (e.g., "America/New_York", "Europe/London")

require_contact_info

boolean | null

Whether to require phone_number or email for user creation. Defaults to true.

phone_number_textable_validation

boolean | null

Whether to validate that phone number is textable. Defaults to true.

lookup_key

string | null

Custom property key (internal_name) to use for user lookup/deduplication. Value is read from custom_user_properties[lookup_key]. Allows matching existing users by external IDs stored in custom properties.

Responses

200

user updated via lookup_key - existing user found

201

user created with lookup_key - new user

403

multi-chapter requires feature

422

lookup_key without value in custom_user_properties