Create a custom-field definition

POST

/custom-field-definitions

const url = 'https://api.de.teamgrid.app/v1/custom-field-definitions';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': 'example',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"configuration":{"groupId":"example","multi":true,"placeholder":"example","type":"contact"},"defaultEnabled":true,"description":"example","required":true,"title":"example","fieldType":"contact","targetType":"contact"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.de.teamgrid.app/v1/custom-field-definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "configuration": { "groupId": "example", "multi": true, "placeholder": "example", "type": "contact" }, "defaultEnabled": true, "description": "example", "required": true, "title": "example", "fieldType": "contact", "targetType": "contact" }'

Authorizations

bearerAuth

Parameters

Header Parameters

Idempotency-Key

required

string

>= 1 characters <= 128 characters /^[!-~]+$/

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

Request Body^required

application/json

The configuration discriminator must equal fieldType.

object

configuration

required

One of:

object

groupId

string

>= 1 characters <= 128 characters

multi

boolean

placeholder

string

<= 500 characters

type

required

string

Allowed value: contact

defaultEnabled

boolean

description

string

<= 5000 characters

required

boolean

title

required

string

>= 1 characters <= 500 characters

fieldType

required

string

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

targetType

required

string

Allowed values: contact project projectJournalEntry task

Responses

200

An idempotent replay of an existing resource.

application/json

object

data

required

object

attributes

required

object

archived

required

boolean

compatibility

required

string

Allowed values: invalid readOnlyLegacy unsupported writable

configuration

required

One of:

object

groupId

string

>= 1 characters <= 128 characters

multi

boolean

placeholder

string

<= 500 characters

type

required

string

Allowed value: contact

createdAt

required

string | null format: date-time

defaultEnabled

required

boolean

description

required

string

<= 5000 characters

fieldType

required

string

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

legacyTargetType

string

<= 128 characters

legacyType

string

<= 128 characters

required

required

boolean

targetType

required

string

Allowed values: contact project projectJournalEntry task unsupported

title

required

string

<= 500 characters

updatedAt

required

string | null format: date-time

required

string

>= 1 characters <= 128 characters

type

required

string

Allowed value: customFieldDefinition

meta

required

object

requestId

required

string

Example

{
  "data": {
    "attributes": {
      "compatibility": "invalid",
      "configuration": {
        "type": "contact"
      },
      "fieldType": "contact",
      "targetType": "contact"
    },
    "type": "customFieldDefinition"
  }
}

Headers

Idempotency-Replayed

string

Allowed values: true

201

A newly created resource.

application/json

object

data

required

object

attributes

required

object

archived

required

boolean

compatibility

required

string

Allowed values: invalid readOnlyLegacy unsupported writable

configuration

required

One of:

object

groupId

string

>= 1 characters <= 128 characters

multi

boolean

placeholder

string

<= 500 characters

type

required

string

Allowed value: contact

createdAt

required

string | null format: date-time

defaultEnabled

required

boolean

description

required

string

<= 5000 characters

fieldType

required

string

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

legacyTargetType

string

<= 128 characters

legacyType

string

<= 128 characters

required

required

boolean

targetType

required

string

Allowed values: contact project projectJournalEntry task unsupported

title

required

string

<= 500 characters

updatedAt

required

string | null format: date-time

required

string

>= 1 characters <= 128 characters

type

required

string

Allowed value: customFieldDefinition

meta

required

object

requestId

required

string

Example

{
  "data": {
    "attributes": {
      "compatibility": "invalid",
      "configuration": {
        "type": "contact"
      },
      "fieldType": "contact",
      "targetType": "contact"
    },
    "type": "customFieldDefinition"
  }
}

Headers

Idempotency-Replayed

string

Allowed values: false

400

The request is invalid.

application/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.

application/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.

application/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.

application/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.

application/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.

application/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.

application/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"
  }
}

Create a custom-field definition

Authorizations

Parameters

Header Parameters

Request Bodyrequired

Responses

200

Example

Headers

201

Example

Headers

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

409

Examplegenerated

429

Examplegenerated

Headers

502

Examplegenerated

503

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated