Update a Counterparty

put

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

Partially update counterparty fields through the command framework.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

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.

externalId

string

Replacement external system identifier when supplied.

parentCounterpartyId

int64

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

counterpartyType

string

enum

Allowed:

taxId

string

Replacement tax identifier when supplied.

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.

payoutDelayDays

int32

Replacement default payout delay in days when supplied.

address

object

Inline address payload used by counterparty create and update requests.

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.