Copy page

Users

Update user profiles

The user update endpoint lets your integration push corrected or enriched profile data into Communal from an external system — a CRM, school information system, or membership database. This guide shows you how to update a user's identity, contact, and address fields, and how to read their custom profile fields.

Before you begin

• Authentication — you need a valid API key.
• Users & activity overview — understand what user data is available and how permissions work.

1. Update basic profile fields

To sync a user's name and contact information, send a PUT request with the required fields (first_name, last_name, email) and any optional fields you want to update. Fields you omit are left unchanged.

Code
curl -X PUT "https://api.getcommunal.com/api/users/89" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane.doe@example.com",
    "preferred_name": "Janey",
    "telephone": "416-555-1234"
  }'

The response confirms the update was applied. The three required fields must always be present even if you're only changing one optional field — this is a full-record update, not a partial patch.

2. Update address information

Address fields follow a structured format with separate fields for each component. Use the ISO 3166-1 alpha-2 country code for profile_country (e.g., CA for Canada, US for United States).

Code
curl -X PUT "https://api.getcommunal.com/api/users/89" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane.doe@example.com",
    "profile_address": "123 Main Street",
    "profile_address_line_2": "Suite 200",
    "profile_city": "Toronto",
    "profile_state": "ON",
    "profile_zip": "M5V 2T6",
    "profile_country": "CA"
  }'

All address fields are nullable — pass null to clear a field.

3. Read custom profile fields

Organizations can define custom profile fields beyond the standard identity, contact, and address fields. These are exposed through two read-only endpoints — one for the field definitions, one for a user's stored values.

Code
# List the field definitions, with each field's values embedded
curl -X GET "https://api.getcommunal.com/api/custom_profile_fields?include=values" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Code
# Read the stored values for a single user
curl -X GET "https://api.getcommunal.com/api/custom_profile_field_values?filter[user_id]=89" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

These endpoints are read-only. For the full reference — embedding parent fields, mapping values to definitions, and paging through results — see Read custom profile fields.

4. Handle errors

The update endpoint returns specific error codes:

• 401 — Authentication failed. Check your API key.
• 403 — Authorization failed. Your API key doesn't have permission to update this user. Non-manager keys can only update the authenticated user's own record.
• 422 — Validation failed. Common causes: missing required fields (first_name, last_name, email) or a duplicate email address within the organization.

Important: The email field must be unique within your organization. If another user already has that email, the update returns a 422 validation error.

What's next

• Read custom profile fields — list custom field definitions and a user's stored values
• Track card deliveries — monitor membership card delivery attempts for users
• Send membership cards — deliver digital cards (which can also create or update user data)
• See the User endpoint in the API Reference for the complete list of writable fields