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 drafts API

The drafts API from Zulip — 4 operation(s) for drafts.

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

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

This API exposes 8 operations across 4 paths, and defines 8 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.

8 operations 4 paths 8 schemas 2 DELETE2 GET2 PATCH2 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 drafts 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 8

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

drafts 8
GET
/drafts
Get drafts
get-drafts → 200
POST
/drafts
Create drafts
create-drafts body → 200400
PATCH
/drafts/{draft_id}
Edit a draft
edit-draft 1 param body → 200404
DELETE
/drafts/{draft_id}
Delete a draft
delete-draft 1 param → 200404
GET
/saved_snippets
Get all saved snippets
get-saved-snippets → 200
POST
/saved_snippets
Create a saved snippet
create-saved-snippet body → 200400
PATCH
/saved_snippets/{saved_snippet_id}
Edit a saved snippet
edit-saved-snippet 1 param body → 200404
DELETE
/saved_snippets/{saved_snippet_id}
Delete a saved snippet
delete-saved-snippet 1 param → 200404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Draft (6 properties), SavedSnippet (4 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…
SavedSnippet
object
Object containing the details of the saved snippet.
4 properties
JsonSuccess
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
Draft
object
A dictionary for representing a message draft.
6 properties 4 required
CodedError
CodedErrorBase

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zulip-drafts-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 invites API
Zulip messages API
Zulip mobile API
Zulip navigation_views API
Zulip real_time_events API
Zulip reminders API