Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Client

Update a client

put/v1/workspaces/{workspaceId}/clients/{id}

Path parameters

idstring required

Represents a client identifier across the system.

Example:44a687e29ae1f428e7ebe305

Represents a client identifier across the system.

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

Query parameters

archive-projectsboolean
mark-tasks-as-doneboolean

Request body

addressstring

Represents a client's address.

archivedboolean

Indicates if client will be archived or not.

ccEmailsstring[]
currencyIdstring

Represents a currency identifier across the system.

emailstring email

Represents a client email.

namestring

Represents a client name.

notestring

Represents additional notes for the client.

Example request

{
  "address": "Ground Floor, ABC Bldg., Palo Alto, California, USA 94020",
  "currencyId": "53a687e29ae1f428e7ebe888",
  "email": "clientx@example.com",
  "name": "Client X",
  "note": "This is a sample note for the client."
}

Response

OK

addressstring

Represents client's address.

archivedboolean

Represents whether a client is archived or not.

ccEmailsstring[]

Represents additional emails for sending invoices.

currencyIdstring

Represents currency identifier across the system.

emailstring

Represents client email.

idstring

Represents client identifier across the system.

namestring

Represents client name.

notestring

Represents saved notes for the client.

workspaceIdstring

Represents workspace identifier across the system.

Example response

{
  "address": "Ground Floor, ABC Bldg., Palo Alto, California, USA 94020",
  "ccEmails": [
    "clientx@example.com"
  ],
  "currencyId": "33t687e29ae1f428e7ebe505",
  "email": "clientx@example.com",
  "id": "44a687e29ae1f428e7ebe305",
  "name": "Client X",
  "note": "This is a sample note for the client.",
  "workspaceId": "64a687e29ae1f428e7ebe303"
}