patch/contacts/{id}Write operation

Update a contact

Use this operation to update a contact. Only documented mutable fields are accepted; omitted fields retain their current values unless the request schema states replacement semantics. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.

Required scopes

contacts:write

Request example

curl --request PATCH \
  --url 'https://api.de.teamgrid.app/v1/contacts/ID' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "birthday": "2026-07-29T09:00:00.000Z",
    "category": "customer",
    "companyTitle": null,
    "customerId": null,
    "emails": null,
    "firstName": null,
    "gender": "female",
    "groupId": null,
    "lastName": null,
    "nickname": null,
    "notes": null,
    "parentContactId": null
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/contacts/ID', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "birthday": "2026-07-29T09:00:00.000Z",
  "category": "customer",
  "companyTitle": null,
  "customerId": null,
  "emails": null,
  "firstName": null,
  "gender": "female",
  "groupId": null,
  "lastName": null,
  "nickname": null,
  "notes": null,
  "parentContactId": null
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/contacts/ID', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "birthday": "2026-07-29T09:00:00.000Z",
  "category": "customer",
  "companyTitle": null,
  "customerId": null,
  "emails": null,
  "firstName": null,
  "gender": "female",
  "groupId": null,
  "lastName": null,
  "nickname": null,
  "notes": null,
  "parentContactId": null
}),
})

const result: ApiResponse = await response.json()

teamgrid contacts update \
  ID \
  --data @payload.json

Example response 2xx

{
  "data": {
    "attributes": {
      "addresses": [
        {
          "address": {
            "city": null,
            "country": null,
            "fullAddress": null,
            "latitude": null,
            "longitude": null,
            "postalCode": null,
            "state": null,
            "street": null,
            "streetNumber": null
          },
          "type": "string"
        }
      ],
      "archived": false,
      "birthday": "2026-07-29T09:00:00.000Z",
      "category": null,
      "companies": [
        {
          "address": null,
          "companyId": null,
          "email": null,
          "phone": null,
          "position": null
        }
      ],
      "companyTitle": "string",
      "createdAt": "2026-07-29T09:00:00.000Z",
      "createdById": null,
      "customerId": null,
      "emails": [
        {
          "email": "string",
          "type": "string"
        }
      ],
      "employeesCount": 0,
      "firstName": "string"
    },
    "id": "string",
    "type": null
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

idpath · 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

idrequired

string

Stable identifier of the resource in the authenticated workspace.

Request body

application/json

birthday

stringdate-timenullable

ISO 8601 timestamp for birthday.

category

stringnullable

Canonical category value for this contact.

customersuppliernull

companyTitle

stringnullable

The company title associated with this contact.

customerId

stringnullable

The customer id associated with this contact.

emails

arraynullable

The emails associated with this contact.

firstName

stringnullable

The first name associated with this contact.

gender

stringnullable

Canonical gender value for this contact.

femalemalenull

groupId

stringnullable

Identifier of the related workspace group.

lastName

stringnullable

The last name associated with this contact.

nickname

stringnullable

The nickname associated with this contact.

notes

stringnullable

The notes associated with this contact.

parentContactId

stringnullable

The parent contact id associated with this contact.

phoneNumbers

arraynullable

The phone numbers associated with this contact.

salutation

stringnullable

The salutation associated with this contact.

Responses

200The request to update a contact succeeded. The response contains the canonical public result and request metadata.application/json

Response schemaapplication/json

required

Contact

Public API representation of contact.

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.

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 IDupdateContactOpenAPI JSON ↗

Documentation feedbackWas this page useful?