Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zulip scheduled_messages API

The scheduled_messages API from Zulip — 2 operation(s) for scheduled_messages.

Zulip scheduled_messages API is one of 17 APIs that Zulip publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include scheduled_messages. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against 5 base URLs: https://{subdomain}.zulipchat.com/api/v1, {server}/api/v1, https://chat.zulip.org/api/v1, http://localhost:9991/api/v1, http://{subdomain}.testserver/json.

4 operations 2 paths 10 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Servers
https://{subdomain}.zulipchat.com/api/v1
{server}/api/v1
https://chat.zulip.org/api/v1
http://localhost:9991/api/v1
http://{subdomain}.testserver/json
Authentication
HTTP Basic
License
Resource Areas
1

Authentication & Security 1

Zulip scheduled_messages API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BasicAuth — Basic authentication, with the user's email as the username, and the API key as the password. The API key can be fetched using the /fetchapikey or /devfetchapi…

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

scheduled_messages 4
GET
/scheduled_messages
Get scheduled messages
get-scheduled-messages → 200
POST
/scheduled_messages
Create a scheduled message
create-scheduled-message body → 200400
PATCH
/scheduled_messages/{scheduled_message_id}
Edit a scheduled message
update-scheduled-message 1 param body → 200400404
DELETE
/scheduled_messages/{scheduled_message_id}
Delete a scheduled message
delete-scheduled-message 1 param → 200404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ScheduledMessageBase (8 properties), JsonResponseBase (1 property). Each schema is shown below with its type and property counts.

JsonSuccessBase
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…
NonExistingChannelIdError
RequiredContent
string
The content of the message. Clients should use the maxmessagelength returned by the [POST /register](/api/register-queue) endpoint to determine the maximum mes…
JsonSuccess
ScheduledMessageBase
object
Object containing details of the scheduled message.
8 properties 7 required
IgnoredParametersUnsupported
array
An array of any parameters sent in the request that are not supported by the endpoint. See [error handling](/api/rest-error-handlingignored-parameters) documen…
JsonResponseBase
object
1 property
ScheduledMessage
CodedError
CodedErrorBase

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zulip-scheduled-messages-api-openapi.yml Raw ↑

Other APIs Zulip publishes across the network.

Zulip REST API
Zulip Events API
Zulip Webhooks
Zulip authentication API
Zulip bots API
Zulip channels API
Zulip drafts API
Zulip invites API
Zulip messages API
Zulip mobile API
Zulip navigation_views API
Zulip real_time_events API