PayConexDecryptxShieldConexTECS Platform
API Reference
Request SandboxContact Us

Update a Client

patch
https://portal-cert.shieldconex.com:4010/api/v1/clients/

This endpoint updates an existing Client resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 20

The Client's unique identifier.

Query Params
string

The name of the client.

string

The billing identifier associated with the client.

string

The Merchant ID (MID) for the client.

boolean

Indicates whether the client is active.

int32

The version of the client record.

int32

The identifier of the direct partner associated with the client.

string

The name of the direct partner associated with the client.

int32

The identifier of the contact associated with the client.

Body Params

Client to be updated.

string
length ≤ 255

The Client's name.

string
length ≤ 50

Billing ID

string
length ≤ 50

Some Partners will have an merchant ids on their own software offerings. This is an open field that allows those Partner associate a Client resource with their Merchant Identifier.

boolean

This property indicates if the Client account is active or disabled. It is not possible to delete Clients, however their account can be set to inactive.

integer

The number of times that this resource has been updated.

directPartner
object

Reference to the associated Partner. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

contact
object
Responses

401

Unauthorized

403

Forbidden

404

Not found

Updated 3 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago