Clear a custom-field value

DELETE

/custom-field-values/{targetType}/{resourceId}/{fieldId}

curl --request DELETE \
  --url https://api.de.teamgrid.app/v1/custom-field-values/contact/example/example \
  --header 'Authorization: Bearer <token>' \
  --header 'If-Match: example'

• German region
• United States region
• Future global compatibility ingress

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.

Authorizations

• bearerAuth

Parameters

Path Parameters

targetType

required

string

Allowed values: contact project project-journal-entry task

resourceId

required

string

>= 1 characters <= 128 characters /^[A-Za-z0-9_-]+$/

fieldId

required

string

>= 1 characters <= 128 characters /^[A-Za-z0-9]+$/

Header Parameters

If-Match

required

string

/^"cfv1-[a-f0-9]{64}"$/

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

Responses

200

The value was cleared or an already-unset state was replayed.

Media typeapplication/json

object

data

required

object

attributes

required

object

fieldId

required

string

>= 1 characters <= 128 characters /^[A-Za-z0-9]+$/

fieldType

required

string

Allowed values: contact date dropdown number project switcher tag text textarea user

replayed

required

Whether the mutation was an idempotent canonical no-op.

boolean

resourceId

required

string

>= 1 characters <= 128 characters /^[A-Za-z0-9_-]+$/

revision

required

string

/^cfv1-[a-f0-9]{64}$/

state

required

string

Allowed values: invalid set unset

targetType

required

string

Allowed values: contact project project-journal-entry task

value

One of:

boolean

boolean

number

number

string

string

<= 100000 characters

Array<string>

Array<string>

>= 1 items <= 100 items unique items

id

required

string

/^cfv_[a-f0-9]{64}$/

type

required

string

Allowed value: customFieldValue

meta

required

object

requestId

required

string

Example

{
  "data": {
    "attributes": {
      "fieldType": "contact",
      "state": "invalid",
      "targetType": "contact"
    },
    "type": "customFieldValue"
  }
}

Headers

ETag

required

string

/^"cfv1-[a-f0-9]{64}"$/

Strong revision tag required verbatim in If-Match before a mutation.

Cache-Control

required

string

Allowed value: private, no-store, no-transform

Prevents shared caching and representation transformations so the strong revision validator remains byte-for-byte usable for conditional requests.

400

The request is invalid.

Media typeapplication/json

object

errors

required

Array<object>

object

code

required

string

detail

required

string

source

object

key

additional properties

string

status

required

string

/^[1-5][0-9]{2}$/

title

required

string

meta

required

object

requestId

required

string

Example^generated

{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

401

The bearer credential is missing, invalid, expired, or revoked.

Media typeapplication/json

object

errors

required

Array<object>

object

code

required

string

detail

required

string

source

object

key

additional properties

string

status

required

string

/^[1-5][0-9]{2}$/

title

required

string

meta

required

object

requestId

required

string

Example^generated

{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

403

The credential has insufficient scope.

Media typeapplication/json

object

errors

required

Array<object>

object

code

required

string

detail

required

string

source

object

key

additional properties

string

status

required

string

/^[1-5][0-9]{2}$/

title

required

string

meta

required

object

requestId

required

string

Example^generated

{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

404

The tenant-scoped resource does not exist.

Media typeapplication/json

object

errors

required

Array<object>

object

code

required

string

detail

required

string

source

object

key

additional properties

string

status

required

string

/^[1-5][0-9]{2}$/

title

required

string

meta

required

object

requestId

required

string

Example^generated

{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

409

The request conflicts with the current resource state.

Media typeapplication/json

object

errors

required

Array<object>

object

code

required

string

detail

required

string

source

object

key

additional properties

string

status

required

string

/^[1-5][0-9]{2}$/

title

required

string

meta

required

object

requestId

required

string

Example^generated

{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

412

The resource changed since the supplied revision.

Media typeapplication/json

object

errors

required

Array<object>

object

code

required

string

detail

required

string

source

object

key

additional properties

string

status

required

string

/^[1-5][0-9]{2}$/

title

required

string

meta

required

object

requestId

required

string

Example^generated

{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

428

A strong If-Match revision is required.

Media typeapplication/json

object

errors

required

Array<object>

object

code

required

string

detail

required

string

source

object

key

additional properties

string

status

required

string

/^[1-5][0-9]{2}$/

title

required

string

meta

required

object

requestId

required

string

Example^generated

{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

429

The credential or source exceeded its rate limit.

Media typeapplication/json

object

errors

required

Array<object>

object

code

required

string

detail

required

string

source

object

key

additional properties

string

status

required

string

/^[1-5][0-9]{2}$/

title

required

string

meta

required

object

requestId

required

string

Example^generated

{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

Headers

Retry-After

integer

>= 1

Minimum delay in seconds before retrying.

X-RateLimit-Limit

integer

Maximum requests in the current window.

X-RateLimit-Remaining

integer

Requests remaining in the current window.

X-RateLimit-Reset

integer

Unix time in milliseconds when the current window resets.

X-Request-Id

string

Request correlation identifier.

502

The cell-local application returned an invalid response.

Media typeapplication/json

object

errors

required

Array<object>

object

code

required

string

detail

required

string

source

object

key

additional properties

string

status

required

string

/^[1-5][0-9]{2}$/

title

required

string

meta

required

object

requestId

required

string

Example^generated

{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}

503

A required cell-local dependency is unavailable.

Media typeapplication/json

object

errors

required

Array<object>

object

code

required

string

detail

required

string

source

object

key

additional properties

string

status

required

string

/^[1-5][0-9]{2}$/

title

required

string

meta

required

object

requestId

required

string

Example^generated

{
  "errors": [
    {
      "code": "example",
      "detail": "example",
      "source": {
        "additionalProperty": "example"
      },
      "status": "example",
      "title": "example"
    }
  ],
  "meta": {
    "requestId": "example"
  }
}