PATCH
/
deliver
/
businesses
/
{id}
curl --request PATCH \
  --url https://api-sandbox.orum.io/deliver/businesses/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '{
  "legal_name": "<string>",
  "business_name": "<string>",
  "entity_type": "sole_proprietorship",
  "tax_id": "<string>",
  "tax_id_type": "tin",
  "account_holder_name": "<string>",
  "incorporation_date": "<string>",
  "addresses": [
    {
      "type": "legal",
      "address1": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "US",
      "zip5": "<string>"
    }
  ],
  "contacts": [
    {
      "type": "email",
      "value": "<string>"
    }
  ],
  "metadata": {}
}'
{
  "business": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_reference_id": "<string>",
    "legal_name": "<string>",
    "business_name": "<string>",
    "entity_type": "<string>",
    "tax_id_type": "<string>",
    "account_holder_name": "<string>",
    "incorporation_date": "<string>",
    "status": "created",
    "addresses": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "home",
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US",
        "zip5": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "contacts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "email",
        "value": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "closed_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Orum-Version
enum<string>
required

Version of Deliver API. Use v2022-09-21.

Available options:
v2022-09-21

Path Parameters

​
id
string
required

Orum generated unique id for the business you are updating.

Body

application/json

Response

200
application/json
200 response.

The response is of type object.