Update a Partner

patch

https://apis.p2pemanager.com/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

The Partner's unique identifier.

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

The Partner's billing identifier.

partnerId

string

The Partner's id.

verificationPhrase

string

length ≤ 255

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.

clientCanOrderEquipment

boolean

This property indicates if the Partner is allowed to order Equipment.

isActive

boolean

This property indicates if the Parter account is active or disabled. It is not possible to delete Partners, their account can be set to inactive as an alternative.

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.

location

object

Reference to the associated Location resource. 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

Reference to the associated User resource. When used for POST and PATCH API calls, the reference must contain the User's id.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

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

application/json

200Partner update response

401Unauthorized

403Forbidden

404Not found

409Invalid data

500Internal server error