Skip to main content

UpdateClientBodyDto

namestring

Name of the client/company

Possible values: >= 2 characters

Example: Acme Corporation
emailstring<email>

Email address of the client

Example: contact@acme.com
citystring

City where the client is located

Example: New York
phonestring

Phone number of the client

Example: +1-555-0123
addressstring

Street address of the client

Example: 123 Business Street
postalCodestring

Postal code of the client

Example: 10001
customerIdstring

Custom customer ID assigned by the workspace

Example: CUST-001
countrystring

Country where the client is located

Example: United States
languagestring

Primary language of the client

Example: en
privateboolean

Whether the client is private or business

Example: false
websitestring<uri>

Website URL of the client

Example: https://acme.com
cocNumberstring

Chamber of Commerce number

Example: COC123456
vatNumberstring

VAT number of the client

Example: VAT987654321
ibanstring

IBAN bank account number

Example: GB82WEST12345698765432
currencystring

Client currency

Possible values: [USD, AUD, GBP, CAD, CNY, EUR, INR, JPY, AED, CHF, BTC, ETH]

tags object[]

Array of custom tags associated with the client

  • Array [
  • idnumberrequired

    Unique identifier for the tag

    valuestringrequired

    The actual value/content of the tag

    Example: Software & IT
  • ]
  • UpdateClientBodyDto
    {
    "name": "Acme Corporation",
    "email": "contact@acme.com",
    "city": "New York",
    "phone": "+1-555-0123",
    "address": "123 Business Street",
    "postalCode": "10001",
    "customerId": "CUST-001",
    "country": "United States",
    "language": "en",
    "private": false,
    "website": "https://acme.com",
    "cocNumber": "COC123456",
    "vatNumber": "VAT987654321",
    "iban": "GB82WEST12345698765432",
    "currency": "USD",
    "tags": [
    {
    "id": 0,
    "value": "Software & IT"
    }
    ]
    }