A business's own details change on the business itself. Each part of it (an owner, a signatory, a bank account, an address, a location) changes on its own page, linked below. Here you update a business's root fields or read it back. For the full field list, jump to the Request reference.

Common use cases

• Update the business's own details, such as trade name, website, or contact. See Scenario 1.
• Read the business back to get each part's id and uri. See Read the business back.

Scenarios

The business's own fields change on the business itself; each part changes where it lives.

Before you begin (all scenarios)

• You have the businessId (or the externalId you set on create).
• You are changing a root business field here; part changes go to that part's page.

Scenario 1: Update the business

The business's own fields change with merge semantics, so send only what changes. Make a PATCH request to /v1/businesses/{businessId}.

curl -X PATCH https://sandbox-api.prioritycommerce.com/v1/businesses/{businessId} \
  -H "x-api-key: <your-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "tradeName": "Example Online Goods",
    "website": "https://example.com"
  }'

The update accepts the business's own fields only: externalId, legalName, tradeName, businessType, businessDescription, website, email, phone, taxFilingName, taxIds, incorporations, documents, and services. If you send a part such as owners or bankAccounts inline here, the request returns 200 but the part is silently ignored: nothing is added or changed. To change a part, use that part's own endpoint:

• Owners and signatories: the people who own and sign for the business
• Bank accounts: funding, billing, and settlement instruments
• Addresses: registered, mailing, and physical addresses
• Locations: the sites where the business operates
• Configure services: the services and features the business enables

Read the business back

Need the exact address of a part? Read the business back and each part carries its own id and uri. Make a GET request to /v1/businesses/{businessId}; add ?expand=true for the full nested profile.

curl "https://sandbox-api.prioritycommerce.com/v1/businesses/{businessId}?expand=true" \
  -H "x-api-key: <your-key>"

Request reference

Next steps

See also

• Create a business: the composite create these updates build on
• Businesses: what each part represents
• Underwriting exceptions: resolve a rejected update