PUT
/
timmi-project
/
api
/
v4
/
clients
/
{clientId}
curl --request PUT \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/timmi-project/api/v4/clients/{clientId} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "code": "<string>",
  "externalCode": null,
  "ownerId": null,
  "organizationId": 123
}'
{
  "id": 123,
  "name": "<string>",
  "code": "<string>",
  "externalCode": null,
  "owner": null
}

Path Parameters

clientId
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 length: 1
code
string
required

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

Minimum length: 1
organizationId
integer
required

Unique identifier of the organization this client belongs to.

externalCode
string | null

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

ownerId
integer | null

Unique identifier of the user managing this client.

Response

200
application/json
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 length: 1
code
string
required

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

Minimum length: 1
id
number
externalCode
string | null

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

owner
object | null

Was this page helpful?