put/custom-field-values/{targetType}/{resourceId}/{fieldId}Write operation

Set a custom-field value

The cell-local App re-authenticates the credential and additionally requires a target-domain scope selected by targetType: contacts:read/write, projects:read/write, project-statements:read/write, or tasks:read/write. Reading a contact, project, tag, or user reference field, and validating a newly set reference, also requires the matching contacts:read, projects:read, tags:read, or users:read scope. Invalid legacy values are classified without exposing their payload.

Required scopes

custom-field-values:write

Conditional scopes

contacts:readcontacts:writeprojects:readprojects:writeproject-statements:writetags:readtasks:writeusers:read

Request example

curl --request PUT \
  --url 'https://api.de.teamgrid.app/v1/custom-field-values/TARGET_TYPE/RESOURCE_ID/FIELD_ID' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "value": null
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/custom-field-values/TARGET_TYPE/RESOURCE_ID/FIELD_ID', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "value": null
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/custom-field-values/TARGET_TYPE/RESOURCE_ID/FIELD_ID', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "value": null
}),
})

const result: ApiResponse = await response.json()

teamgrid custom-field-values update \
  TARGET_TYPE \
  --data @payload.json \
  --if-match REVISION

Example response 2xx

{
  "data": {
    "attributes": {
      "fieldId": "example",
      "fieldType": "contact",
      "replayed": false,
      "resourceId": "example",
      "revision": "example",
      "state": "invalid",
      "targetType": "contact",
      "value": null
    },
    "id": "example",
    "type": "string"
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

targetTypepath · requiredresourceIdpath · requiredfieldIdpath · requiredIf-Matchheader · 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.

Path parameters

targetTyperequired

string

Supported TeamGrid resource type that owns the custom-field value.

contactprojectproject-journal-entrytask

resourceIdrequired

string

Stable identifier of the target resource in the authenticated workspace.

fieldIdrequired

string

Identifier of the custom-field definition whose value is being addressed.

Headers

If-Matchrequired

string

Exactly one strong ETag returned by the latest GET or mutation response. Wildcards, weak validators, and lists are rejected.

Request body

application/json

valuerequired

CustomFieldValueValue

Canonical value represented by this field.

Responses

200The value was set or an identical canonical value was replayed.application/json

Response schemaapplication/json

required

CustomFieldValueMutation

Public API representation of custom field value mutation.

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.

404The tenant-scoped resource does not exist.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.

412The resource changed since the supplied revision.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.

428A strong If-Match revision is required.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 IDsetCustomFieldValueOpenAPI JSON ↗

Documentation feedbackWas this page useful?