Update an API client

PUT
/apiclients/{apiClientID}

Description

If an object with the same ID already exists, it will be overwritten.

Roles

At least one of the roles below is required to access this endpoint

FullAccess
ApiClientAdmin

Parameters

NameTypeDescriptionPossible Values
apiClientIDstringID of the api client.---

Request Body

PropertyTypeFormatMax LengthPossible Values
ClientSecretstring---------

AccessTokenDuration
Required
integerint32------
Activeboolean---------

AppName
Required
string---------
RefreshTokenDurationintegerint32------
DefaultContextUserNamestring---------

xpobject---------
AllowAnyBuyerboolean---------

AllowAnySupplierboolean---------

AllowSellerboolean---------

IsAnonBuyerboolean---------

OrderCheckoutIntegrationEventIDstring---------

MinimumRequiredRolesarray---------
MinimumRequiredCustomRolesarray---------
MaximumGrantedRolesarray---------
MaximumGrantedCustomRolesarray---------

Response Body

PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---------

ClientSecretstring---------

AccessTokenDurationintegerint32------
Activeboolean---------

AppNamestring---------
RefreshTokenDurationintegerint32------
DefaultContextUserNamestring---------

xpobject---------
AllowAnyBuyerboolean---------

AllowAnySupplierboolean---------

AllowSellerboolean---------

IsAnonBuyerboolean---------

AssignedBuyerCount
Read Only
integerint32------
AssignedSupplierCount
Read Only
integerint32------
OrderCheckoutIntegrationEventIDstring---------

OrderCheckoutIntegrationEventName
Read Only
string---------
MinimumRequiredRolesarray---------
MinimumRequiredCustomRolesarray---------
MaximumGrantedRolesarray---------
MaximumGrantedCustomRolesarray---------