Skip to main content
PATCH
Update a Counterparty

Authorizations

Authorization
string
header
required

API key for authentication. Get your key from the Dashboard > Settings > API Access.

Path Parameters

id
string
required

The id of the counterparty. Expected to be a valid object id like 666666666666666666666666

Pattern: ^[0-9A-Fa-f]{24}$

Body

application/json
email
string<email> | null

The email of the counterparty

otherEmails
string<email>[] | null

The other emails of the counterparty

phone
string | null

The phone of the counterparty

address
object | null

The address of the counterparty

taxId
string | null

The tax id of the counterparty

accountName
string

The account name of the counterparty

accountNumber
string

The account number of the counterparty

type
enum<string>

The type of the counterparty

Available options:
customer,
vendor,
both

Response

Update a Counterparty executed successfully

message
string

Success message

metaData
object
data
object