paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-24 00:23:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
bb735460e5c1baa9d715a995ea81ff338ea66572
zulip/api_docs/create-or-update-scheduled-messages.md
Lauryn Menard d41f12495d api-docs: Document create/edit scheduled message endpoint and events. 
Adds API changelog update for the new endpoint added for creating
or editing scheduled messages, for the events sent for scheduled
messages (add, update, delete), and for the `scheduled_messages`
field in the register response.

Adds a specific API markdown documentation file for the create
or update scheduled messages endpoint, so that the parameters in
the cURL examples are accurate for the type of message (direct or
stream) and action (create or edit).

Bumps the API feature level, adds Changes notes to API documentation
and adds the scheduled message endpoints to the API documentation
sidebar.
2023-04-28 17:25:00 -07:00

2.0 KiB
Raw Blame History

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

# Create a scheduled stream message
curl -X POST {{ api_url }}/v1/scheduled_messages \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode type=stream \
    --data-urlencode to=9 \
    --data-urlencode topic=Hello \
    --data-urlencode 'content=Thank you for' \
    --data-urlencode scheduled_delivery_timestamp=3165826990

# Update a scheduled stream message
curl -X POST {{ api_url }}/v1/scheduled_messages \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode type=stream \
    --data-urlencode to=9 \
    --data-urlencode 'topic=Welcome aboard' \
    --data-urlencode 'content=Thank you for the help!' \
    --data-urlencode scheduled_delivery_timestamp=3165856990 \
    --data-urlencode scheduled_message_id=1

# Create a scheduled direct message
curl -X POST {{ api_url }}/v1/messages \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode type=direct \
    --data-urlencode 'to=[9, 10]' \
    --data-urlencode 'content=Can we meet tomorrow?' \
    --data-urlencode scheduled_delivery_timestamp=3165826990

# Update a scheduled direct message
curl -X POST {{ api_url }}/v1/messages \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode type=direct \
    --data-urlencode 'to=[9, 10, 11]' \
    --data-urlencode 'content=Can we meet tomorrow?' \
    --data-urlencode scheduled_delivery_timestamp=3165856990 \
    --data-urlencode scheduled_message_id=2

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