Update user field

What it is for: Update user field. Use this to define and maintain custom user fields used for broker segmentation, eligibility, reporting, and integration payloads.

How to use it: Send a PUT request to /v1/communities/{communityId}/user-fields/{fieldId}. Authorization: Bearer <apiKey> or an admin bearer token, depending on the owning API surface. The key must be scoped to the community and have user-field access.

Successful response: HTTP 200. The body follows the endpoint schema; many integration endpoints wrap the useful payload under data with status and message.

Common error states:

400 invalid request body, query, ObjectId, pagination, file format, or missing required field.

401 missing, invalid, expired, or insufficient API key/token.

403 key is valid but cannot access this community/channel/user/resource, where supported by the service.

404 target resource, route, or community-scoped record was not found.

409 duplicate or conflicting state for create/update operations, where applicable.

500 unexpected Returning.AI service error.

curl --location --request PUT 'https://api.returning.ai/v1/communities/6167dba9c548eb5c7ec28057/user-fields/6857de260f3c24d98fd7ca85' \ --header 'Content-Type: application/json' \ --data '{ "name": "Department", "type": "text" }'

{ "meta": { "status": "success", "statusCode": 200 }, "message": "Updated user field", "data": { "_id": "6857de260f3c24d98fd7ca85", "field": "department", "name": "Department", "type": "text", "creator": { "_id": "61100af5c548eb5c7ebc7819", "avatar": "https://returning-ai.com/avatar.png", "displayName": "Admin", "username": "admin" }, "createdAt": "2025-06-22T11:28:50.301Z", "updatedAt": "2025-06-22T11:30:15.456Z" } }

Request

Responses