Create a Partner

post

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

This will let a Partner create a (sub) Partner. Typically, this is an organization construct used to group Clients. For example, the Partner may want to create a (sub) Partner to group together 10 Clients so they are logically grouped for reporting purposes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

required

The name of the entity.

reference

string

required

A reference identifier for the entity. It's recommended that uuidv4 format be used.

billingId

string

required

Billing identifier associated with the entity.

verificationPhrase

string

A phrase used for verification purposes when calling to request a change to the Partner.

isActive

boolean

required

Status indicating if the Partner is active.

parent.id

int32

Identifier of the parent Partner.

parent.name

string

Name of the parent Partner.

contact.userName

string

required

Username of the contact.

contact.firstName

string

required

First name of the contact.

contact.lastName

string

required

Last name of the contact.

contact.email

string

required

Email address of the contact.

contact.phone

string

required

Phone number of the contact.

contact.userRole

string

enum

required

Role of the contact within the organization.

Allowed:

contact.isActive

boolean

required

Indicates if the contact is currently active.

contact.sendWelcomeEmail

boolean

required

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

Body Params

Partner to be created.

name

string

required

length ≤ 255

The Partner's name.

reference

string

length ≤ 255

The Partner's reference string. This reference is used in to identify the Partner on the Decryption APIs. It equates to the Partner ID.

billingId

string

length ≤ 50

The Partner's billing identifier.

verificationPhrase

string

The verification phrase is a message that the Partner creates. It can be used as a mechanism to authorize a partner when they initiate communication over the phone.

isActive

boolean

This property indicates if the Parter account is active or disabled.

parent

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

200Partner create response

409Invalid data

500Internal server error