Test And Accept
API ReferenceClients

Update a client

Updates an existing client

PATCH
/clients/{id}
AuthorizationBearer <token>

Clerk authentication token

In: header

Path Parameters

idstring
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$
Formatuuid
name?string
Length1 <= length <= 255
description?string
website?string
Formaturi
industry?string

Response Body

curl -X PATCH "http://localhost:3001/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "website": "string",
  "industry": "string",
  "organizationId": "string",
  "isPinned": true,
  "pinnedAt": "2019-08-24T14:15:22Z",
  "contacts": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
      "name": "string",
      "email": "string",
      "phone": "string",
      "role": "string",
      "isPrimary": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}