Create Client

Create a new client to group sites and track submissions by customer or brand.

clients.create

POST/v1/clients

Request Body

Parameter	Type	Description
name*	string	Client name (max 255 chars)
contactName	string	Primary contact name
contactEmail	string	Primary contact email
contactPhone	string	Primary contact phone number
color	string	Brand color hex code (e.g. #10B981)
logo	string	Logo URL
notes	string	Internal notes about the client

name*string

Client name (max 255 chars)

contactNamestring

Primary contact name

contactEmailstring

Primary contact email

contactPhonestring

Primary contact phone number

colorstring

Brand color hex code (e.g. #10B981)

logostring

Logo URL

notesstring

Internal notes about the client

Example Request

curl

curl -X POST "https://proforms.io/api/v1/clients" \
  -H "Authorization: Bearer pf_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corp",
    "contactName": "Jane Smith",
    "contactEmail": "jane@acme.com",
    "contactPhone": "801-555-1234",
    "color": "#10B981",
    "notes": "Enterprise client — monthly retainer"
  }'

Response

200 OK

{
  "success": true,
  "data": {
    "id": "c_abc123",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "color": "#10B981",
    "logo": null,
    "contactName": "Jane Smith",
    "contactEmail": "jane@acme.com",
    "contactPhone": "801-555-1234",
    "notes": "Enterprise client — monthly retainer",
    "createdAt": "2026-02-17T10:00:00.000Z"
  }
}

💡

A URL-friendly slug is auto-generated from the client name. If a slug already exists in your organization, a unique suffix is appended.