Update a Counterparty

put

https://embarc-api-qa.lendapi.com/embarc-core/api/v1/counterparties/{id}

Partially update counterparty fields through the command framework. Business name must remain unique; nonblank external ID and tax ID must also remain unique, while null or blank external ID and tax ID values may be reused.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Embarc counterparty identifier.

Body Params

Partial update payload for the counterparty. Only supplied fields are considered for update.

Partial update payload for an existing counterparty.

businessName

string

Replacement business name when supplied. Must be nonblank and unique after trimming, whitespace normalization, and case folding.

externalId

string

Replacement external system identifier when supplied. Nonblank values must be unique after trimming and case folding; null or blank values may be reused.

parentCounterpartyId

integer

Parent counterparty identifier. The current implementation updates the parent only when a non-null value is supplied.

counterpartyType

string

enum

Supported counterparty category. MERCHANT is the only type treated as the lender/merchant on a loan link and is the only type that can carry payout-delay and tenant-fee fields on the link. INVESTOR and VENDOR are the other supported counterparty categories.

Allowed:

taxId

string

Replacement tax identifier when supplied. Nonblank values must be unique after trimming and case folding; null or blank values may be reused.

website

uri

length ≤ 2048

Absolute HTTP(S) URL. officeId and contacts are not accepted on update.

contactName

string

Replacement primary contact name.

contactEmail

string

Replacement primary contact email address.

contactPhone

string

Replacement primary contact phone number.

secondaryContactName

string

Replacement secondary contact name.

secondaryContactEmail

string

Replacement secondary contact email address.

secondaryContactPhone

string

Replacement secondary contact phone number.

isActive

boolean

Replacement active flag when supplied.

address

object

Inline address payload used by counterparty create and update requests. The create flow requires this object, and the underlying address record requires addressLine1, city, zip, and ISO-2 country.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200Counterparty updated successfully.