Change a client

Changes a client record. Only the fields you send change; send null to clear one. archived=true files the client away (its sites keep running).

PATCH/api/v1/clients/{client_id}

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the clients:write scope — add and edit clients; invite and remove client logins.

clients:writeChanges the draft or a recordIdempotency-Key optionalMCP tool: update_client

Parameters

Named placeholders go in the path; the rest in a JSON body.

client_idstringPath · required: The client's id.1 to 100 characters
namestringBody · optional: 2 to 120 characters
contact_namestring | nullBody · optional: The person you deal with.At most 120 characters
emailstring | nullBody · optional: The client's email address.At most 200 characters
phonestring | nullBody · optional: Phone number.At most 40 characters
addressstring | nullBody · optional: Postal address.At most 240 characters
notesstring | nullBody · optional: Private notes — never shown to the client.At most 2000 characters
archivedbooleanBody · optional

Response

200 with JSON on success (schema on the right). Errors use the standard envelope; a retry with the same Idempotency-Key gets the first answer back (how retries work).

curl

curl -X PATCH 'https://websites.workflowcorp.com/api/v1/clients/CLIENT_ID' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phone":"(555) 010-9900"}'

Example arguments

{
  "client_id": "CLIENT_ID",
  "phone": "(555) 010-9900"
}

Response schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "contact_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "email": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "phone": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "address": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "archived": {
      "type": "boolean"
    },
    "site_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "is_sample": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "contact_name",
    "email",
    "phone",
    "address",
    "notes",
    "archived",
    "site_ids",
    "is_sample",
    "created_at"
  ],
  "additionalProperties": false
}