COcommercelayer
vertex_accounts

Update a vertex account

Changed on

Update a vertex account

patch/vertex_accounts/{vertexAccountId}

Request

  • Base URL
    https://{your_organization_slug}.commercelayer.io/api
  • URL
    https://{your_organization_slug}.commercelayer.io/api/vertex_accounts/{vertexAccountId}
  • Auth
    HTTP bearer

Path parameters

vertexAccountIdstring required

The resource's id

Request body

Example request

{
  "data": {
    "id": "XAyRWNUzyN",
    "attributes": {
      "name": "Personal tax calculator",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      },
      "kind": "cloud",
      "baseurl": "yourbaseurl",
      "audience": "verx://xyz",
      "client_id": "xxx-yyy-zzz",
      "client_secret": "xxx-yyy-zzz",
      "commit_invoice": true,
      "_refresh_token": true
    }
  }
}

Response

The updated vertex account object

Changes