POST /realm/profile_fields
Create a custom profile field in the user's organization.
Servers
- https://{subdomain}.zulipchat.com/api/v1
- {server}/api/v1
- https://chat.zulip.org/api/v1
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No |
The name of the custom profile field, which will appear both in user-facing settings UI for configuring custom profile fields and in UI displaying a user's profile. |
editable_by_user |
Boolean | No |
Whether regular users can edit this profile field on their own account. Note that organization administrators can edit custom profile fields for any user regardless of this setting. Changes: New in Zulip 10.0 (feature level 296). |
required |
Boolean | No |
Whether an organization administrator has configured this profile field as required. Because the required property is mutable, clients cannot assume that a required custom profile field has a value. The Zulip web application displays a prominent banner to any user who has not set a value for a required field. Changes: New in Zulip 9.0 (feature level 244). |
use_for_user_matching |
Boolean | No |
Whether this custom profile field should be used to match users in typeahead suggestions. Only allowed for Short Text and External Account profile field types. This field is only included when its value is Changes: New in Zulip 12.0 (feature level 455). |
field_type |
Integer | Yes |
The field type can be any of the supported custom profile field types. See the custom profile fields documentation for more details on what each type means.
Changes: Field type |
display_in_profile_summary |
Boolean | No |
Whether clients should display this profile field in a summary section of a user's profile (or in a more easily accessible "small profile"). At most 2 profile fields may have this property be true in a given organization. The "Users" profile field is not supported, but that is likely to be temporary. Changes: Before Zulip 12.0 (feature level 476), the "Paragraph" field type was not supported. New in Zulip 6.0 (feature level 146). |
hint |
String | No |
The help text to be displayed for the custom profile field in user-facing settings UI for configuring custom profile fields. |
field_data |
Object | No |
Field types 3 (Dropdown) and 7 (External account) support storing
additional configuration for the field type in the For field type 3 (Dropdown), this attribute is a JSON dictionary defining the choices and the order they will be displayed in the dropdown UI for individual users to select an option. The interface for field type 7 is not yet stabilized. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.