Update a Partner

patch

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

This endpoint updates an existing Partner 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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

length ≤ 20

Partner id.

Query Params

name

string

The name of the partner.

reference

string

A reference identifier for the partner.

billingId

string

Billing identifier associated with the partner.

verificationPhrase

string

Verification phrase for security purposes.

isActive

boolean

Indicates if the partner is active.

version

int32

Version number for the partner record.

parent.id

int32

Identifier of the parent partner entity.

parent.name

string

Name of the parent partner entity.

contact.id

int32

Identifier of the contact person for the partner.

Body Params

Partner to be updated.

name

string

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.

version

integer

The number of times that this resource has been updated.

parent

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

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Partner update response

409Invalid data

500Internal server error