Skip to main content
PUT
/
timmi-project
/
api
/
v4
/
clients
/
{id}
Update a Client by id
curl --request PUT \
  --url https://{host}/timmi-project/api/v4/clients/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "code": "<string>",
  "organizationId": 123,
  "externalCode": "<unknown>",
  "ownerId": "<unknown>"
}
'
{
  "name": "<string>",
  "code": "<string>",
  "id": 123,
  "externalCode": "<unknown>",
  "owner": "<unknown>"
}

Headers

​
Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Path Parameters

​
id
integer
required

Identifier of the client.

Body

application/json

A client must belong to a single organization.

The organizationId field is required upon creation (POST) and cannot be modified later.

​
name
string
required
Minimum string length: 1
​
code
string
required

Unique code for this client. Used for identifying the client in invoices export if externalCode is null.

Minimum string length: 1
​
organizationId
integer
required

Unique identifier of the organization this client belongs to.

​
externalCode
null | string

Used for identifying the client in invoices exports. Is not subject to unicity.

​
ownerId
null | integer

Unique identifier of the user managing this client.

Response

OK

A client must belong to a single organization.

The organizationId field is required upon creation (POST) and cannot be modified later.

​
name
string
required
Minimum string length: 1
​
code
string
required

Unique code for this client. Used for identifying the client in invoices export if externalCode is null.

Minimum string length: 1
​
id
number
​
externalCode
null | string

Used for identifying the client in invoices exports. Is not subject to unicity.

​
owner
object