Some checks failed
Code scanning / CodeQL (push) Failing after 15s
Zulip production suite / Ubuntu 22.04 production build (push) Failing after 26s
Zulip production suite / Debian 12 production install with custom db name and user (push) Has been skipped
Zulip production suite / Ubuntu 22.04 production install and PostgreSQL upgrade with pgroonga (push) Has been skipped
Zulip production suite / Ubuntu 24.04 production install (push) Has been skipped
Zulip production suite / Ubuntu 26.04 production install (push) Has been skipped
Zulip production suite / Debian 13 production install (push) Has been skipped
Zulip production suite / 7.0 Version Upgrade (push) Has been skipped
Zulip production suite / 8.0 Version Upgrade (push) Has been skipped
Zulip production suite / 6.0 Version Upgrade (push) Has been skipped
Zulip production suite / 10.0 Version Upgrade (push) Has been skipped
Zulip production suite / 9.0 Version Upgrade (push) Has been skipped
Zulip production suite / 12.0 Version Upgrade (push) Has been skipped
Zulip production suite / 11.0 Version Upgrade (push) Has been skipped
GitHub Actions Security Analysis with zizmor / zizmor (push) Failing after 3s
Zulip CI / Debian 12 (Python 3.11, backend + documentation) (push) Failing after 26s
Zulip CI / Ubuntu 22.04 (Python 3.10, backend + frontend) (push) Failing after 3s
Zulip CI / Ubuntu 24.04 (Python 3.12, backend) (push) Failing after 25s
Zulip CI / Ubuntu 26.04 (Python 3.14, backend) (push) Failing after 25s
Zulip CI / Debian 13 (Python 3.13, backend) (push) Failing after 28s
Zulip production suite / Required jobs (push) Has been cancelled
Zulip CI / Required jobs (push) Has been cancelled
API Documentation Update Check / check-feature-level-updated (push) Has been cancelled
API Documentation Update Check / notify-if-api-docs-changed (push) Has been cancelled
52 lines
1.3 KiB
Markdown
52 lines
1.3 KiB
Markdown
{generate_api_header(/scheduled_messages:post)}
|
|
|
|
## Usage examples
|
|
|
|
{start_tabs}
|
|
|
|
{generate_code_example(python)|/scheduled_messages:post|example}
|
|
|
|
{generate_code_example(javascript)|/scheduled_messages:post|example}
|
|
|
|
{tab|curl}
|
|
|
|
{!curl-auth-credentials.md!}
|
|
|
|
``` curl
|
|
# Create a scheduled channel message
|
|
curl -X POST {{ api_url }}/v1/scheduled_messages \
|
|
-u EMAIL_ADDRESS:API_KEY \
|
|
--data-urlencode type=stream \
|
|
--data-urlencode to=9 \
|
|
--data-urlencode topic=Hello \
|
|
--data-urlencode 'content=Nice to meet everyone!' \
|
|
--data-urlencode scheduled_delivery_timestamp=3165826990
|
|
|
|
# Create a scheduled direct message
|
|
curl -X POST {{ api_url }}/v1/messages \
|
|
-u EMAIL_ADDRESS:API_KEY \
|
|
--data-urlencode type=direct \
|
|
--data-urlencode 'to=[9, 10]' \
|
|
--data-urlencode 'content=Can we meet on Monday?' \
|
|
--data-urlencode scheduled_delivery_timestamp=3165826990
|
|
|
|
```
|
|
|
|
{end_tabs}
|
|
|
|
## Parameters
|
|
|
|
{generate_api_arguments_table|zulip.yaml|/scheduled_messages:post}
|
|
|
|
{generate_parameter_description(/scheduled_messages:post)}
|
|
|
|
## Response
|
|
|
|
{generate_return_values_table|zulip.yaml|/scheduled_messages:post}
|
|
|
|
{generate_response_description(/scheduled_messages:post)}
|
|
|
|
#### Example response(s)
|
|
|
|
{generate_code_example|/scheduled_messages:post|fixture}
|