Edit Partner

SaaS only

This API is Applicable only for SaaS Environment

This is used by MSP to update their reseller partners. Partner update is asynchronous.

application/json

Request Body

name string required
Partner Name
externalId string required
Partner ID in MSP system
website string
Partner website
contacts object[] required
Partner contacts
type string required
Default value: primary
Contact type.We currently support "primary" type only.
email string required
Contact email. It needs to be a valid email and unique in Metallic.
firstName string required
Contact first name
lastName string required
Contact last name
address object
Contact address
addressLine1 string required
Street address
addressLine2 string
Street address continued
city string required
City
state string
This field is required when country is United States, otherwise is optional. If provided, it must be ISO standard code or name.
country string required
Country
postalCode string required
Postal Code
workloadAccess boolean required
Access to manage accounts

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

data object
id string
insertTs string
updateTs string
name string
externalId string
website string
status string
contacts object[]
email string
firstName string
lastName string
address object
addressLine1 string
city string
state string
country string
postalCode string
type string
workloadAccess boolean

{
  "data": {
    "id": "string",
    "insertTs": "string",
    "updateTs": "string",
    "name": "string",
    "externalId": "string",
    "website": "string",
    "status": "string",
    "contacts": [
      {
        "email": "string",
        "firstName": "string",
        "lastName": "string",
        "address": {
          "addressLine1": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "postalCode": "string"
        },
        "type": "string"
      }
    ],
    "workloadAccess": true
  }
}

{
  "data": {
    "id": "2dde73c6-10c7-4299-924b-c81c60e33e14",
    "insertTs": "2022-06-21T17:49:29",
    "updateTs": "2022-06-22T17:49:29",
    "name": "Partner 1-1",
    "externalId": "msp1-partner-1-1",
    "website": "partner1-1.com",
    "status": "upadting",
    "contacts": [
      {
        "email": "admin1@partner1-1.com",
        "firstName": "Admin",
        "lastName": "User",
        "address": {
          "addressLine1": "22 Rd",
          "city": "Santa Clara",
          "state": "California",
          "country": "United States",
          "postalCode": "94054"
        },
        "type": "primary"
      }
    ],
    "workloadAccess": false
  }
}

Edit Partner​

Edit Partner