Reorder all linkifiers

PATCH https://ms-a0402-2024.zulip.aalto.fi/api/v1/realm/linkifiers

Change the order that the regular expression patterns in the organization's linkifiers are matched in messages and topics. Useful when defining linkifiers with overlapping patterns.

Changes: New in Zulip 8.0 (feature level 202). Before this feature level, linkifiers were always processed in order by ID, which meant users would need to delete and recreate them to reorder the list of linkifiers.

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# Reorder the linkifiers in the user's organization.
order = [4, 3, 2, 1]
request = {"ordered_linkifier_ids": json.dumps(order)}

result = client.call_endpoint(url="/realm/linkifiers", method="PATCH", request=request)
print(result)

curl -sSX PATCH https://ms-a0402-2024.zulip.aalto.fi/api/v1/realm/linkifiers \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode 'ordered_linkifier_ids=[3, 2, 1, 5]'

Parameters

ordered_linkifier_ids (integer)[] required

Example: [3, 2, 1, 5]

A list of the IDs of all the linkifiers defined in this organization, in the desired new order.


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"
}