Update Client

Update a client's name, contact info, branding, or notes.

clients.edit

PUT/v1/clients/:id

Request Body

Parameter	Type	Description
name	string	Client name (max 255 chars)
contactName	string	Primary contact name (null to clear)
contactEmail	string	Primary contact email (null to clear)
contactPhone	string	Primary contact phone (null to clear)
color	string	Brand color hex code (null to clear)
logo	string	Logo URL (null to clear)
notes	string	Internal notes (null to clear)

namestring

Client name (max 255 chars)

contactNamestring

Primary contact name (null to clear)

contactEmailstring

Primary contact email (null to clear)

contactPhonestring

Primary contact phone (null to clear)

colorstring

Brand color hex code (null to clear)

logostring

Logo URL (null to clear)

notesstring

Internal notes (null to clear)

Example Request

curl

curl -X PUT "https://proforms.io/api/v1/clients/c_abc123" \
  -H "Authorization: Bearer pf_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "contactEmail": "support@acme.com",
    "notes": "Upgraded to premium plan"
  }'

Response

200 OK

{
  "success": true,
  "data": {
    "id": "c_abc123",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "color": "#10B981",
    "logo": null,
    "contactName": "Jane Smith",
    "contactEmail": "support@acme.com",
    "contactPhone": "801-555-1234",
    "notes": "Upgraded to premium plan",
    "updatedAt": "2026-02-17T14:30:00.000Z"
  }
}

💡

If you change the client name, the slug is automatically regenerated to match.