Create partner

Select

SaaS

This is used by MSP to introduce their reseller partners. MSP will provide basic info of their reseller partners. MSP can enable reseller partner's access to command center to manage account workload if needed. Partner provisioning 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

Created

application/json

Schema
Example (from schema)
Example 1

Schema

data object
id string
Partner Metallic ID
insertTs string
Partner created time
updateTs string
Partner last updated time
name string
Partner name
externalId string
Partner ID in MSP system
website string
status string
Partner status
contacts object[]
Partner contacts
email string
firstName string
lastName string
address object
addressLine1 string
city string
state string
country string
postalCode string
type string
workloadAccess boolean
Ability to manage accounts workload

{
  "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-21T17:49:29",
    "name": "Partner 1",
    "externalId": "msp1-partner-1",
    "website": "partner1.com",
    "status": "provisioning",
    "contacts": [
      {
        "email": "admin@partner1.com",
        "firstName": "Admin",
        "lastName": "User",
        "address": {
          "addressLine1": "1 Rd",
          "city": "Santa Clara",
          "state": "California",
          "country": "United States",
          "postalCode": "94051"
        },
        "type": "primary"
      }
    ],
    "workloadAccess": false
  }
}

POST /api/v1/partner/partners

Authorization

Request

Click Edit to configure Base URL

https://api.metallic.io

Bearer Token

lhAccountId — header

Body

Default
Create Partner without workload Access
Create Partner with workload access

{
  "name": "string",
  "externalId": "string",
  "website": "string",
  "contacts": [
    {
      "type": "primary",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postalCode": "string"
      }
    }
  ],
  "workloadAccess": true
}

curl -L -X POST 'https://api.metallic.io/api/v1/partner/partners' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "externalId": "string",
  "website": "string",
  "contacts": [
    {
      "type": "primary",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postalCode": "string"
      }
    }
  ],
  "workloadAccess": true
}'

curl -L -X POST 'https://api.metallic.io/api/v1/partner/partners' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "externalId": "string",
  "website": "string",
  "contacts": [
    {
      "type": "primary",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postalCode": "string"
      }
    }
  ],
  "workloadAccess": true
}'

curl -L -X POST 'https://api.metallic.io/api/v1/partner/partners' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "externalId": "string",
  "website": "string",
  "contacts": [
    {
      "type": "primary",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postalCode": "string"
      }
    }
  ],
  "workloadAccess": true
}'

curl -L -X POST 'https://api.metallic.io/api/v1/partner/partners' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "externalId": "string",
  "website": "string",
  "contacts": [
    {
      "type": "primary",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postalCode": "string"
      }
    }
  ],
  "workloadAccess": true
}'

curl -L -X POST 'https://api.metallic.io/api/v1/partner/partners' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "externalId": "string",
  "website": "string",
  "contacts": [
    {
      "type": "primary",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postalCode": "string"
      }
    }
  ],
  "workloadAccess": true
}'

curl -L -X POST 'https://api.metallic.io/api/v1/partner/partners' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "externalId": "string",
  "website": "string",
  "contacts": [
    {
      "type": "primary",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postalCode": "string"
      }
    }
  ],
  "workloadAccess": true
}'

curl -L -X POST 'https://api.metallic.io/api/v1/partner/partners' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "externalId": "string",
  "website": "string",
  "contacts": [
    {
      "type": "primary",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postalCode": "string"
      }
    }
  ],
  "workloadAccess": true
}'

Create partner​

Authorization

Request

Create partner