Skip to main content
POST
Validate a field

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Query Parameters

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Body

application/json

A candidate field definition. Validation runs the same checks as creating the field, without saving anything.

bucket
integer

Target bucket ID. Defaults to the org's default bucket when omitted.

label
string

Display label. Used to generate name when name is omitted.

name
string

Machine name. Generated from label when omitted.

type
string

Field type.

{key}
any

Any other field-definition key accepted on create.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
any[]

No payload — data is an empty array.