Clients and projects

Change a client

PATCHhttps://paysuitett.com/api/v1/clients/{id}

Changes a client in the directory. Send only what changes. Projects name their client, so a new name is carried onto the client's projects too.

Access. Master key only.

Path parameters

idstring · uuidrequired: The client's ID, from GET /clients.

Body

A JSON object. Every field is optional.

namestring: The new name, up to 200 characters. Refused if another client has it.
emailstring: Email address; empty to clear.
phonestring: Phone number; empty to clear.
addressstring: Address; empty to clear.

Response

200 with a JSON body, as in the example.

curl -X PATCH "https://paysuitett.com/api/v1/clients/4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b" \
  -H "Authorization: Bearer $PAYSUITETT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"21PG Recruiting Ltd"}'

Success

{
  "client": {
    "id": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b",
    "name": "21PG Recruiting Ltd",
    "email": null,
    "phone": null,
    "address": null
  }
}