Skip to main content
PATCH
/
v1
/
businesses
/
{id}
Update a business
curl --request PATCH \
  --url https://api.slant.app/v1/businesses/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Corp",
  "industry": "<string>",
  "website_url": "<string>",
  "tax_id": "<string>",
  "additional_info": "<string>",
  "email_addresses": [
    {
      "email": "jsmith@example.com",
      "email_type": "personal",
      "is_primary": true
    }
  ],
  "phone_numbers": [
    {
      "phone_number": "<string>",
      "phone_type": "mobile",
      "is_primary": true
    }
  ],
  "addresses": [
    {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country_code": "<string>",
      "address_type": "home",
      "is_primary": true
    }
  ],
  "tag_ids": [
    "<string>"
  ]
}
'
{
  "id": "abc123xyz",
  "book_id": "book123xyz",
  "name": "Acme Corp",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "industry": "Technology",
  "website_url": "https://acme.com",
  "tax_id": "12-3456789",
  "additional_info": "<string>",
  "email_addresses": [
    {
      "email": "john.doe@example.com",
      "email_type": "personal",
      "is_primary": true
    }
  ],
  "phone_numbers": [
    {
      "phone_number": "+15555551234",
      "phone_type": "mobile",
      "is_primary": true
    }
  ],
  "addresses": [
    {
      "address_type": "home",
      "is_primary": true,
      "line1": "123 Main St",
      "line2": "Apt 4B",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
      "country_code": "US"
    }
  ],
  "tags": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Headers

Idempotency-Key
string

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

Path Parameters

id
string
required

The business ID

Body

application/json
name
string

Business name

Example:

"Updated Corp"

industry
string

Industry

website_url
string

Website URL

tax_id
string

Tax ID

additional_info
string

Additional information

email_addresses
object[]

Array of email addresses (replaces existing)

phone_numbers
object[]

Array of phone numbers (replaces existing)

addresses
object[]

Array of addresses (replaces existing)

tag_ids
string[]

Array of tag IDs to associate

Response

business updated

id
string
required

The business ID

Example:

"abc123xyz"

book_id
string
required

The book ID

Example:

"book123xyz"

name
string
required

Business name

Example:

"Acme Corp"

created_at
string<date-time>
required

When the business was created

updated_at
string<date-time>
required

When the business was last updated

industry
string | null

Industry

Example:

"Technology"

website_url
string | null

Website URL

Example:

"https://acme.com"

tax_id
string | null

Tax ID

Example:

"12-3456789"

additional_info
string | null

Additional information

email_addresses
object[]

Array of email addresses

phone_numbers
object[]

Array of phone numbers

addresses
object[]

Array of addresses

tags
object[]

Array of tags