Remove your profile data

DELETE https://chat.zulip.org/api/v1/users/me/profile_data

Remove the current user's profile data for one or more of the custom profile fields configured in the organization.

Usage examples

curl -sSX DELETE https://chat.zulip.org/api/v1/users/me/profile_data \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode 'data=[1]'

Parameters

Response

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}

An example JSON error response when editing custom profile fields is restricted in the organization:

{
    "code": "BAD_REQUEST",
    "msg": "You are not allowed to change this field. Contact an administrator to update it.",
    "result": "error"
}

An example JSON error response when a custom profile field ID does not exist:

{
    "code": "BAD_REQUEST",
    "msg": "Field id 99 not found.",
    "result": "error"
}