Update a linkifier
PATCH https://chat.ocaml.pro/api/v1/realm/filters/{filter_id}
Update a linkifier, regular
expression patterns that are automatically linkified when they appear
in messages and topics.
Changes: New in Zulip 4.0 (feature level 57).
Usage examples
#!/usr/bin/env python3
import zulip
# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")
# Update the linkifier (realm_filter) with ID 4
filter_id = 4
request = {
"pattern": "#(?P<id>[0-9]+)",
"url_template": "https://github.com/zulip/zulip/issues/{id}",
}
result = client.call_endpoint(
url=f"/realm/filters/{filter_id}", method="PATCH", request=request
)
print(result)
curl -sSX PATCH https://chat.ocaml.pro/api/v1/realm/filters/5 \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
--data-urlencode 'pattern=#(?P<id>[0-9]+)' \
--data-urlencode 'url_template=https://github.com/zulip/zulip/issues/{id}'
Parameters
filter_id integer required in path
Example: 5
The ID of the linkifier that you want to update.
pattern string required
Example: "#(?P<id>[0-9]+)"
url_template string required
Example: "https://github.com/zulip/zulip/issues/{id}"
The RFC 6570
compliant URL template used for the link.
If you used named groups in pattern
, you can insert their
content here with {name_of_group}
.
Changes: New in Zulip 7.0 (feature level 176). This replaced
the url_format_string
parameter, which was a format string in which
named groups' content could be inserted with %(name_of_group)s
.
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"
}