PATCH /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).

Servers

Path parameters

Name Type Required Description
filter_id Integer Yes

The ID of the linkifier that you want to update.

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
example_input String No

An example input string that matches the linkifier's pattern. This is required for reverse linkifiers. Passing an empty string will set this field back to null.

Changes: New in Zulip 12.0 (feature level 471).

url_template String Yes

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.

pattern String Yes

The Python regular expression that should trigger the linkifier.

alternative_url_templates[] Array No

An array of additional RFC 6570 compliant URL template strings that are used for reverse linkification (converting pasted URLs to linkifier pattern text). These templates have no effect on forward linkification.

Changes: New in Zulip 12.0 (feature level e2b257).

reverse_template String No

A simple template using {variable} for variables that can be used to generate the Markdown linkifier syntax, given a URL matching the URL template. Passing an empty string will set this field back to null.

Server verifies that variables extracted from example_input using url_pattern when passed to reverse_template returns example_input back to us.

{{ "{{/}}" }} can be used for literal {/} characters.

Changes: New in Zulip 12.0 (feature level 471).

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.