How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zywave Files API

The Files API from Zywave — 4 operation(s) for files.

Zywave Files API is one of 84 APIs that Zywave publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 60 JSON Schema definitions.

Tagged areas include File. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 60 JSON Schemas.

This API exposes 6 operations across 4 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version v2.0.

Requests are made against a single base URL, https://api.zywave.com.

6 operations 4 paths 20 schemas 1 DELETE1 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2.0
Base URL
https://api.zywave.com
Authentication
OpenID Connect, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Zywave Files API declares 2 security schemes for authenticating requests. It supports OpenID Connect (oidc) discovered at https://auth.zywave.com//.well-known/openid-configuration. It accepts HTTP bearer tokens (JWT) (bearer). By default, every request must be authenticated.

  • bearer — Enter your JWT access token

Paths & Operations 6

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

Files 6
GET
/bkb/v2.0/file/download
Downloads the binary content of a file attached to an entity as octet-stream.
File_Download 2 params → 200400401403404default
PATCH
/bkb/v2.0/file/{fileId}
Moves a file to another folder or archives it via JSON Patch RFC 6902.
File_PatchFile 2 params body → 200400401403404409422default
DELETE
/bkb/v2.0/file/{fileId}
Soft-deletes a file by moving it to the recycle bin.
File_RecycleFile 1 param → 204401403404409502default
PUT
/bkb/v2.0/file/{fileId}
Updates file name, folder assignment, or access level without re-uploading…
File_UpdateFileMetadata 2 params body → 200404412401403default
POST
/bkb/v2.0/file
Searches active files for an entity by type, ID, with an optional folder or…
File_GetFiles body → 200400401403404default
POST
/bkb/v2.0/file/upload
Uploads a file as multipart/form-data to an entity.
File_Create 1 param body → 201400401403409413422502

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are File (22 properties), FileResponse (11 properties), SearchFilesCriteria (8 properties), FileMetadataResponse (7 properties). Each schema is shown below with its type and property counts.

BaseActivityType
string
ActivityInfo
object
3 properties
SearchFilesCriteria
object
8 properties
FileType
string
User
object
4 properties
UpdateFileMetadataRequest
object
3 properties
FileAccessLevel
string
FileStatus
string
Attachment
object
6 properties
EntityType
string
ProblemDetails
object
6 properties
AttachmentType
string
AttachmentFile
HttpValidationProblemDetails
OperationBase
object
3 properties
Operation
File
object
22 properties
FileResponse
object
Single file resource response.
11 properties
ValidationProblemDetails
FileMetadataResponse
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zywave-files-api-openapi.yml Raw ↑

Other APIs Zywave publishes across the network.

Zywave Account API
Zywave Account Contact API
Zywave Account Contact Driver API
Zywave Account Contacts API
Zywave Account External Reference API
Zywave Accounts API
Zywave Activation API
Zywave Activities API
Zywave Agency API
Zywave Agency Data API
Zywave Agency User API
Zywave Assessment API
Where this information came from

This is an independent, third-party profile of Zywave Files API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.