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

Must be a valid, deliverable address. A non-blank email that fails validation (subaddressing like user+tag@, disposable domains, domains without MX records) returns a 422. Blank values are ignored; to clear an email use clear_email.

clear_email

boolean | null

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

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 chapters, but the primary chapter is always kept. 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. Removing the primary chapter returns 422. 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

Older single value field. Use secondary_languages instead. Saved as a one item secondary_languages list. When sent together with secondary_languages, it is stored in the older second_language field as sent.

secondary_languages

array of strings | null

Language codes the person also speaks, for example ["es", "fr"]. Codes are saved in lowercase.

secondary_languages

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. For an Object property, send the title or value of an existing record (GET /custom_user_properties/{custom_user_property_id}/records), not its sub-values. Sub-values live on the record: create records and set their data with POST /custom_user_properties/{custom_user_property_id}/records. When the property has Limit to One Selection on (object_schema limit_to_one), send one title, which replaces the current selection; otherwise send an array of titles. Send an array when a record title contains a comma. Values that match no record are ignored.

clear_custom_user_properties

Internal names of custom properties to clear on this person. Accepts one internal name or an array of internal names. Multiple Checkboxes and Object properties are saved as an empty array, and other properties as an empty string. This is the only way to clear a Date or Date & Time property. A name that matches no property the person's chapters can see is ignored. A name that is also sent in custom_user_properties returns a 422.

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. Object properties without Limit to One Selection follow the same rule.

add_tags

array of strings | null

Tags to add to the person. A name that does not exist yet creates the tag. Names match exactly and are case sensitive.

add_tags

remove_tags

array of strings | null

Tags to remove from the person. Names match exactly and are case sensitive. When a name is in both add_tags and remove_tags, the tag is removed.

remove_tags

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

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

422

conflicting or invalid parameters, failed validation, or invalid chapter operation

200user updated

401The API key is missing or invalid, the billing plan has no API access, or the account is inactive.

404user not found