Create a Client

post

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

This endpoint allows a Partner to create a Client resource. When creating a Client, a contact and location must also be created. A direct Partner account must also be referenced.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

required

The name of the client.

billingId

string

Billing identifier associated with the client.

mid

string

Merchant ID associated with the client.

isActive

boolean

required

Indicates if the client is active.

directPartner.id

int32

required

Identifier of the direct partner associated with the client.

directPartner.name

string

required

Name of the direct partner associated with the client.

contact.userName

string

required

Username of the primary contact.

contact.firstName

string

required

First name of the primary contact.

contact.lastName

string

required

Last name of the primary contact.

contact.email

string

required

Email address of the primary contact.

contact.phone

string

required

Phone number of the primary contact.

contact.userRole

string

enum

required

Role of the primary contact within the organization.

Allowed:

contact.isActive

boolean

required

Indicates if the primary contact is active.

contact.sendWelcomeEmail

boolean

required

Indicates if a welcome email should be sent to the contact.

Body Params

Client to be created.

name

string

required

length ≤ 255

The Client's name.

billingId

string

length ≤ 50

Billing ID

mid

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.

isActive

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.

directPartner

object

required

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

required

Responses

401

Unauthorized

403

Forbidden

200Client create response

409Invalid data

500Internal server error