zulip/templates/zerver/api/render-message.md

Render message

{generate_api_description(/messages/render:post)}

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/messages/render:post|example}

{tab|js}

More examples and documentation can be found here.

{generate_code_example(javascript)|/messages/render:post|example}

{tab|curl}

{generate_code_example(curl)|/messages/render:post|example}

{end_tabs}

Parameters

{generate_api_arguments_table|zulip.yaml|/messages/render:post}

Response

Return values

{generate_return_values_table|zulip.yaml|/messages/render:post}

Example response

A typical successful JSON response may look like:

{generate_code_example|/messages/render:post|fixture(200)}