Create configuration in a document type

post

https://api.sensible.so/v0/document_types/{type-id}/configurations

Pass the configuration as stringified JSON.

Path Params

type-id

uuid

required

The unique document type identifier in v4 UUID format. Find IDs using the /document_types endpoint.

Body Params

name

string

required

Unique user-friendly name for a configuration

configuration

string

required

JSON-stringified configuration. If you test this endpoint using the Try It button in this interactive API explorer, the explorer stringifies the JSON for you when you paste the configuration into this parameter. To support publishing drafts, this API doesn’t reject requests with configuration errors. To validate, compare your configuration to the latest version of the configuration schema, published at https://schema.sensible.so/configuration.schema.json.

publish_as

string

enum

length between 3 and 128

Destination environment for publication, as a target for later extraction. If you specify an environment, the configuration must be valid. If you don't specify an environment, Sensible saves this version of the configuration as the current draft.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200The created configuration

400Bad Request

401Not authorized

404Not Found

415Unsupported Media Type

500Internal Server Error