---
title: "PUT /vendors/{id}"
method: PUT
path: "/vendors/{id}"
tags: ["Vendor", "Vendors"]
---

# PUT /vendors/{id}

`PUT /vendors/{id}`

## Request

- Base URL: `https://api.railz.ai`
- URL: `https://api.railz.ai/vendors/{id}`
- Auth: HTTP bearer

PUT an update to a vendor for a business.

## Path parameters

- `id` string, required

## Request body

- PushUpdateVendorV1Dto
  - `connection` PushUpdateVendorConnection, required
    - `businessName` string, required: Unique business name identifier.
    - `serviceName` 'quickbooks' | 'xero' | 'freshbooks' | 'dynamicsBusinessCentral' | 'oracleNetsuite' | 'sageIntacct' | 'sageBusinessCloud', required: Name of accounting platform service.
  - `data` PutVendorV1, required
    - `contactFirstName` string
    - `contactLastName` string
    - `emailAddress` string
    - `phone` string
    - `website` string, uri
    - `isPerson` boolean
    - `vendorName` string
    - `addresses` Addresses[]
      - `type` 'billing' | 'shipping', required: Only Billing & Shipping types can be used when creating records.
      - `line1` string
      - `line2` string
      - `city` string
      - `region` string: Region within a country. For example, state name for USA, province name for Canada.
      - `country` string: Country name as 3 ISO alpha-3 characters.
      - `postalCode` string: Postal code. For example, zip code for USA and Canada.
    - `defaultCurrency` string
    - `subsidiaryRefs` string[]

## Response `200`

- PutVendorV1ResponseDto
  - `pushCommunicationId` string, required
  - `requestedOn` string, date-time, required
  - `status` 'success' | 'failed' | 'pending', required
  - `businessName` string, required
  - `serviceName` 'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' | 'byod', required
  - `data` PutVendorV1, required
    - `contactFirstName` string
    - `contactLastName` string
    - `emailAddress` string
    - `phone` string
    - `website` string, uri
    - `isPerson` boolean
    - `vendorName` string
    - `addresses` Addresses[]
      - `type` 'billing' | 'shipping', required: Only Billing & Shipping types can be used when creating records.
      - `line1` string
      - `line2` string
      - `city` string
      - `region` string: Region within a country. For example, state name for USA, province name for Canada.
      - `country` string: Country name as 3 ISO alpha-3 characters.
      - `postalCode` string: Postal code. For example, zip code for USA and Canada.
    - `defaultCurrency` string
    - `subsidiaryRefs` string[]

## Other responses

- `400`: Bad Request Error - Thrown if fields sent via query does not follow specifications
- `401`: Unauthorized - Not logged in or log in expired
- `403`: Forbidden - Not enough permission
- `500`: Server Error

## Changes

- **2026-09-03** `1383b9a47ac9`: 1 info
  - api tag `Vendor` added

[Operation history](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api/changes/vendors/:id/put.md)

---

[API](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api.md) - [All operations](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/railz/apis/fis-accounting-data-as-a-service-api/revisions/1383b9a47ac9?raw)