Updates a user

put

https://api.solidarity.tech/v1/users/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

ID of the user to update

Body Params

phone_number

string | null

clear_phone_number

boolean | null

When true, clears the user's primary phone number (and removes it from other_phone_numbers). Blank phone_number values are always ignored, so this explicit flag is the only way to clear a phone number via the API. Cannot be combined with a non-blank phone_number in the same request (returns 422).

string | null

first_name

string | null

last_name

string | null

alternate_name

string | null

Alternate name (nickname, community name, or alternate romanization). Searchable. Blank values are ignored; an existing alternate name cannot be cleared via the API.

preferred_language

string | null

chapter_id

integer | null

Primary chapter ID (backwards compatible)

chapter_ids

array of integers | null

Full array of chapter IDs (replaces all). Requires multi-chapter feature.

chapter_ids

add_chapter_ids

array of integers | null

Array of chapter IDs to add. Requires multi-chapter feature.

add_chapter_ids

remove_chapter_ids

array of integers | null

Array of chapter IDs to remove. Requires multi-chapter feature.

remove_chapter_ids

set_exclusive_chapter

boolean | null

When true with chapter_id, sets that chapter as the only chapter (removes all other chapter memberships).

second_language

string | null

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. Use an array of strings for Multiple Checkboxes fields. Comma-separated strings are also accepted for Multiple Checkboxes. 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.

address

object | null

Optional address to update. 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")

donation_charge

object | null

Optional external donation charge to create

Responses

200

user updated

422

cannot set and clear the phone number in the same request

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here!