Create a custom field definition

Authorization

Bearer

AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Field name

Length1 <= length <= 255

options?array<>

Non-empty options, required only for select fields

Items1 <= items

slug?string

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

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

Lengthlength <= 64

type*string

Field type

Value in

workspace_id?string

Workspace ID to scope this field to

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

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

Found something wrong? Help us improve this page.

Custom Fields

Delete a custom field definition DELETE

Deletes the field definition and all associated values.