Create a custom-field definition

Creates a custom-field definition. fieldName, fieldKey, and
displayLabel are required. fieldKey must be unique among active
definitions in the account; testing_framework is reserved (trimmed,
case-insensitive). The call checks account capacity and allows at most 30
options. A nonblank URL default must start with http:// or https://.
Test-case values support six field types, not TAG or URL. Do not put
credentials in default or option text.
Requires the CustomField:Create permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

Nonblank field name.

string
required
length ≥ 1

Nonblank immutable key; reserved testing_framework prohibited.

string
enum
Defaults to TEXT

Definition types. Test-case values support six types, not TAG or URL.

objectTypes
array of strings
Defaults to []

Entities the definition applies to. Values can be set through the API only on TEST_CASE.

objectTypes
string
required
length between 1 and 50

Nonblank.

string | null
boolean
Defaults to false
boolean
Defaults to true
boolean
Defaults to false
boolean
Defaults to true
boolean
Defaults to true
string | null

Nonblank URL default checked only on create.

fieldOptions
array of objects | null
fieldOptions
Headers
uuid
required

Required resolved account UUID; no default. Does not grant permission or override ownership.

int64
required

Project ID, required on every request. It selects the project context; it is not a record ID and does not grant permissions.

int64

Optional numeric organization context; does not grant membership or permission.

Responses

400

Invalid payload, context, or ID; an ownership or lifecycle restriction; a capacity limit; or a TrueTest failure. The error body format varies.

401

Authentication or the required user context is missing or invalid. The error body format varies.

403

The caller lacks the operation permission or access to the resource. Headers do not grant access. The error body format varies.

default

Any other error. The error body format varies.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Choose an example:
application/json