GuidesChangelogAPI Reference
API Reference

/api/v5/schema/{schema_id}

put
https://percolate.com/api/v5/schema/

Update and return a schema.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
ext
required
fields
array of objects
required

An ordered list of fields

fields*
fieldsets
array of objects

An ordered array of fieldset objects

fieldsets
plugins
array of objects

A list of plugins

plugins
string
required

A name identifying the schema

required
string
enum
required

Schema type.

limit_resource_types
array of strings

Ability to assign a schema to a specific resource type. Certain schema types must can only be applied to one resource type (ex. post). Others (ex. metadata), can be applied to multiple resource types.

limit_resource_types
string
enum
required

Whether this schema can be used to create other resources.

Allowed:
conditions
array

A set of conditions that define field dependencies or cascading values for the schema.

Conditions
platform_ids
array of strings | null

An array of platform IDs the schema applies to. Send null if the schema applies to all platforms.

platform_ids
Responses

Retry-After header

Updated over 2 years ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago