Sign in

v1

latestOpenAPI 3.0.12026-07-268028223.9 KB
Businesses

Update a business

Update an existing business

patch/v1/businesses/{id}

Path parameters

idstring required

The business ID

Headers

Idempotency-Keystring

Unique key to ensure idempotent request handling. If a request with the same key was already processed, the original response will be returned.

Request body

namestring

Business name

industrystring

Industry

website_urlstring

Website URL

tax_idstring

Tax ID

additional_infostring

Additional information

tag_idsstring[]

Array of tag IDs to associate

Example request

{
  "name": "Updated Corp"
}

Response

business updated

idstring required

The business ID

book_idstring required

The book ID

namestring required

Business name

industrystring nullable

Industry

website_urlstring nullable

Website URL

tax_idstring nullable

Tax ID

additional_infostring nullable

Additional information

created_atstring date-time required

When the business was created

updated_atstring date-time required

When the business was last updated

Example response

{
  "id": "abc123xyz",
  "book_id": "book123xyz",
  "name": "Acme Corp",
  "industry": "Technology",
  "website_url": "https://acme.com",
  "tax_id": "12-3456789",
  "email_addresses": [
    {
      "email": "john.doe@example.com",
      "email_type": "personal",
      "is_primary": true
    }
  ],
  "phone_numbers": [
    {
      "phone_number": "+15555551234",
      "extension": "1234",
      "phone_type": "mobile",
      "is_primary": true
    }
  ],
  "addresses": [
    {
      "line1": "123 Main St",
      "line2": "Apt 4B",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
      "country_code": "US",
      "address_type": "home",
      "is_primary": true
    }
  ]
}