Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Client

Add a new client

post/v1/workspaces/{workspaceId}/clients

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

Request body

addressstring

Represents a client's address.

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",
  "email": "clientx@example.com",
  "name": "Client X",
  "note": "This is a sample note for the client."
}

Response

Created

addressstring

Represents client's address.

archivedboolean

Represents whether a client is archived or not.

ccEmailsstring[]

Represents additional emails for sending invoices.

currencyCodestring

Represents client currency code.

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"
  ],
  "currencyCode": "USD",
  "currencyId": "33t687e29ae1f428e7ebe505",
  "email": "clientx@example.com",
  "id": "44a687e29ae1f428e7ebe305",
  "name": "Client X",
  "note": "This is a sample note for the client.",
  "workspaceId": "64a687e29ae1f428e7ebe303"
}