Create a custom field definition

Custom Fields

Authorization

Bearer

AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_*)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Field name

Length1 <= length <= 255

type*string

Field type

Value in"text" | "number" | "date" | "boolean" | "select"

slug?string

URL-safe identifier (auto-generated from name if omitted)

Match^[a-z0-9_]+$

Lengthlength <= 64

options?array<string>

Options for select type (required when type is select)

workspace_id?string

Workspace ID to scope this field to

Response Body

`application/json`

curl -X POST "https://api.relayapi.dev/v1/custom-fields" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "text"  }'

{
  "id": "string",
  "name": "string",
  "slug": "string",
  "type": "text",
  "options": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}

Found something wrong? Help us improve this page.

Report an issue Edit this page on GitHub

Custom Fields

Delete a custom field definition DELETE

Deletes the field definition and all associated values.

Create a custom field definition

Authorization

Request Body

Response Body

201application/json

400application/json

409application/json

`application/json`

`application/json`

`application/json`