Create partner
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 requiredDefault value:
primary
Contact type.We currently support "primary" type only.
email string requiredContact email. It needs to be a valid email and unique in Metallic.
firstName string requiredContact first name
lastName string requiredContact last name
address object
Contact address
addressLine1 string requiredStreet address
addressLine2 stringStreet address continued
city string requiredCity
state stringThis field is required when country is United States, otherwise is optional. If provided, it must be ISO standard code or name.
country string requiredCountry
postalCode string requiredPostal Code
- workloadAccess boolean required
Access to manage accounts
- 200
- 201
OK
Created
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
data object
id stringPartner Metallic ID
insertTs stringPartner created time
updateTs stringPartner last updated time
name stringPartner name
externalId stringPartner ID in MSP system
website stringstatus stringPartner status
contacts object[]
Partner contacts
email stringfirstName stringlastName stringaddress object
addressLine1 stringcity stringstate stringcountry stringpostalCode stringtype stringworkloadAccess booleanAbility 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
}
}