Test And Accept
API ReferenceClients

Pin a client

Pins a client to the top of the list

POST
/clients/{id}/pin
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

Response Body

curl -X POST "http://localhost:3001/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08/pin"
{
  "success": true
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}