zulip/templates/zerver/api/create-custom-profile-field.md

Create a custom profile field

{generate_api_description(/realm/profile_fields:post)}

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/realm/profile_fields:post|example(admin_config=True)}

{tab|curl}

{generate_code_example(curl)|/realm/profile_fields:post|example}

{end_tabs}

Parameters

{generate_api_arguments_table|zulip.yaml|/realm/profile_fields:post}

Response

Return values

{generate_return_values_table|zulip.yaml|/realm/profile_fields:post}

Example response

A typical successful JSON response may look like:

{generate_code_example|/realm/profile_fields:post|fixture(200)}