Update a client

Updates a client's details. Supports partial updates — only include fields you want to change. Set a nullable field to null to clear it.

Authorization

apiKey

AuthorizationBearer <token>

API key issued from your AgentInvoice account settings.

In: header

Path Parameters

id*integer

Client ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Client's full name or business name

email?string

Primary email address for invoicing

phone?|

Phone number, or null to clear

company?|

Company/organization name, or null to clear

addressLine1?|

Street address line 1, or null to clear

addressLine2?|

Street address line 2, or null to clear

city?|

City, or null to clear

state?|

State or province, or null to clear

postalCode?|

Postal or ZIP code, or null to clear

country?|

Country code or name, or null to clear

notes?|

Internal notes, or null to clear

Response Body

`application/json`

curl -X PATCH "https://app.agentinvoice.co/api/clients/0" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": 42,
  "name": "Acme Corp",
  "email": "billing@acme.com",
  "phone": "string",
  "company": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "country": "string",
  "notes": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}