post/custom-field-definitionsWrite operation

Create a custom-field definition

Use this operation to create a custom-field definition. The server validates the complete payload and derives workspace ownership from the authenticated credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Use a stable Idempotency-Key when retrying so a transport timeout cannot create duplicate work.

Required scopes

custom-field-definitions:write

Request example

curl --request POST \
  --url 'https://api.de.teamgrid.app/v1/custom-field-definitions' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "configuration": null,
    "defaultEnabled": false,
    "description": "string",
    "required": false,
    "title": "string",
    "fieldType": "contact",
    "targetType": "contact"
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/custom-field-definitions', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "configuration": null,
  "defaultEnabled": false,
  "description": "string",
  "required": false,
  "title": "string",
  "fieldType": "contact",
  "targetType": "contact"
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/custom-field-definitions', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "configuration": null,
  "defaultEnabled": false,
  "description": "string",
  "required": false,
  "title": "string",
  "fieldType": "contact",
  "targetType": "contact"
}),
})

const result: ApiResponse = await response.json()

teamgrid custom-field-definitions create \
  --data @payload.json \
  --idempotency-key REQUEST_KEY

Example response 2xx

{
  "data": {
    "attributes": {
      "archived": false,
      "compatibility": "invalid",
      "configuration": null,
      "createdAt": "2026-07-29T09:00:00.000Z",
      "defaultEnabled": false,
      "description": "string",
      "fieldType": "contact",
      "legacyTargetType": "string",
      "legacyType": "string",
      "required": false,
      "targetType": "contact",
      "title": "string"
    },
    "id": "string",
    "type": "string"
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

Idempotency-Keyheader · required

JSON request bodyValid JSON

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Headers

Idempotency-Keyrequired

string

Unique request key retained for seven days. Within that window, reuse with different data is rejected.

Request body

application/json

configurationrequired

CustomFieldDefinitionWritableConfiguration

Type-specific, validated configuration for this resource.

defaultEnabled

boolean

Whether default enabled applies to this custom field definition.

description

string

Human-readable description of the resource.

required

boolean

Whether required applies to this custom field definition.

titlerequired

string

Human-readable title of the resource.

fieldTyperequired

string

Canonical type used to validate and interpret the custom field.

contactdatedropdownnumberprojectswitchertagtexttextareauser

targetTyperequired

string

Canonical type of the target resource.

contactprojectprojectJournalEntrytask

Responses

200An idempotent replay of an existing resource.application/json

Response schemaapplication/json

required

CustomFieldDefinition

Public API representation of custom field definition.

required

ResponseMeta

Public API representation of meta.

201The request to create a custom-field definition created the resource. The response contains its canonical public representation and request metadata.application/json

Response schemaapplication/json

required

CustomFieldDefinition

Public API representation of custom field definition.

required

ResponseMeta

Public API representation of meta.

400The request is invalid.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

401The bearer credential is missing, invalid, expired, or revoked.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

403The credential has insufficient scope.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

409The request conflicts with the current resource state.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

502The cell-local application returned an invalid response.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

503A required cell-local dependency is unavailable.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDcreateCustomFieldDefinitionOpenAPI JSON ↗

Documentation feedbackWas this page useful?