PATCH
/
api
/
users
/
{id}

​
Requirements to consume the endpoint.

Create and modify role

The user must have the role to create and modify.

Authorizations

x-api-key
string
headerrequired

Path Parameters

id
string
required

Body

application/json
individualData
object
invoicing
object
onboarding
object

Response

200 - application/json
invoicing
object
individualData
object
createdAt
string

Creation date of the user.

type
enum<string>

Type of the user.

Available options:
business,
individual
phoneNumber
string

Phone number of the user.

email
string

Email of the user.

attributes
enum<string>[]
Available options:
disabled,
banned,
broker,
brokerCustomer,
summedVolumeFees,
noReissueQuoteAfterExpiration,
prepaidOrders,
hasTransfersEnabled,
noVolatilityError,
brokerFeesEnabled,
canUploadKYCReportFile,
shortQuote,
needsAddressApproval,
canPriceMatch,
doNotSendOrderConfirmationEmail,
doNotSendOnboardingEmails
onboarding
object
id
string

ID of the user.

Update current userGet Webhook by id