Update a business

patch

https://sandbox-api.prioritycommerce.com/v1/businesses/{id}

Updates the details of a business. Send only the fields you want to change; everything else stays the same. To change owners, signatories, bank accounts, locations or addresses, use their own endpoints.

externalId can be added if the business does not have one yet, but it cannot be changed once set.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

ID of the business, for example bus_3f8a2c71-9d4e-4b6a-8f15-6c2e9a7b4d10.

Body Params

Business fields to update. Send only the fields you want to change.

externalId

string

length ≤ 255

Your own reference for this record, up to 255 characters. Use it to find the record later with the externalId filter.

legalName

string

The full legal name of the business, exactly as registered with the government.

tradeName

string

length ≤ 150

The name customers know the business by, also called the DBA ("doing business as") name. Up to 150 characters.

businessType

string

enum

The legal structure of the business. Values are not case-sensitive, and common alternatives are accepted, for example corporation for c_corporation or tax_exempt for tax_exempt_501c3. Needed to activate card processing (payin.card).

businessDescription

string

length ≤ 512

A short description of what the business sells or does, up to 512 characters. Needed to activate card processing (payin.card).

website

string

length ≤ 512

The website of the business, up to 512 characters.

string

Main contact email address.

phone

string

^\+[1-9]\d{1,14}$

Main contact phone number in international E.164 format: a +, the country code, then the number, with no spaces. Example: +15125550142.

taxFilingName

string

length ≤ 50

The name the business uses on its tax filings, if different from legalName. Up to 50 characters.

taxIds

array of objects

Tax identification numbers of the business. Send one primary tax ID. Needed to activate card processing (payin.card).

taxIds

incorporations

object

Where and when the business was legally formed. Needed to activate card processing (payin.card).

documents

array of objects

Documents from your document library to attach, such as the signed merchant agreement. The merchant agreement is needed to activate card processing (payin.card).

documents

services

object

Services to enable for the business, such as card processing, and their optional features.

Headers

idempotency-key

string

Optional. A unique value, such as a UUID, that identifies this request. If you retry with the same key, the change is not applied twice.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Updated. The response contains the updated record.

401The API key is missing or invalid.

404No record exists with the ID in the path.

422The request failed validation. errors lists each field to fix.