Skip to main content
POST
/
schemas
Create schema
curl --request POST \
  --url https://api.sftpsync.io/schemas \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "fields": [
    {
      "name": "<string>",
      "type": "<string>",
      "required": true,
      "description": "<string>",
      "validation": {}
    }
  ]
}'
{
  "id": "<string>",
  "name": "<string>",
  "version": 123,
  "description": "<string>",
  "fields": [
    {
      "name": "<string>",
      "type": "<string>",
      "required": true,
      "description": "<string>",
      "validation": {}
    }
  ],
  "workspaceId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required
fields
object[]
required
description
string

Response

200 - application/json

Schema

id
string
required
name
string
required
fields
object[]
required
workspaceId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
version
integer
description
string