Create Reseller

This API can be used to provision a new reseller in Metallic. Reseller provisioning is synchronous.

Request Body

Field	Description	Type	Required	Notes
externalId	Reseller ID in Partner system	String / UUID	True	Needs to be unique in metallic.
name	Reseller name	String	True	Needs to be unique in metallic.
website	Reseller website	String	False
contacts	Reseller contacts	Contact Objects Array	True	See - Contact Object
workloadAccess	Access to manage accounts	Boolean	False

Contact Object

Field	Description	Type	Required	Notes
type	Contact type	String Enum Allowed Values: "primary"	True	Only 'primary' is supported currently.
email	Contact email	String	True	Needs to be unique in metallic.
firstName	Contact firstname	String	True
lastName	Contact lastname	String	True
address	Contact address	Address Object	True	See - Address Object
phone	Contact phone number	String	False

Address Object

Field	Description	Type	Required	Notes
addressLine1	Address line 1	String	True
addressLine2	Address line 2	String	False
city	Address city	String	True
state	Address state	String	Conditional Mandatory	This field is required when country is United States, otherwise is optional. If provided, it must be ISO standard code or name.
country	Address country	String	True	It must be ISO standard code or name.
postalCode	Address postal code	String	True

Response Body

Field	Description	Type	Notes
id	Reseller metallic id	UUID
type	Type indicating it is reseller	String Enum allowed values: "reseller"
status	Reseller status	String Enum allowed values: "active"
insertTs	Reseller created time	Timestamp
updateTs	Reseller last updated time	Timestamp
externalId	Reseller ID in Partner system	String / UUID	Same as input.
name	Reseller name	String	Same as input.
website	Reseller website	String	Same as input.
contacts	Reseller contacts	Contact Objects array	Same as input. Refer to Contact Object on request.
workloadAccess	Access to manage accounts	Boolean	Same as input.

application/json

Request Body required

• name string required
• website string
• contacts object[] required

  email string required

  firstName string required

  lastName string required

  phone string

  address object required

  addressLine1 string required

  city string required

  state string

  Required when country is optional

  country string required

  postalCode string required

  addressLine2 string

  type string required
• externalId string required
• workloadAccess boolean required

Responses

• 201
• 400

---

Created

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• data object

  id string

  insertTs string

  updateTs string

  name string

  type string

  status string

  contacts object[]

  email string

  firstName string

  lastName string

  phone string

  address object

  addressLine1 string

  city string

  state string

  Required when country is optional

  country string

  postalCode string

  addressLine2 string

  type string

  website string

  externalId string

  workloadAccess boolean

{
  "data": {
    "id": "e4295015-6535-4989-9457-1ba12040a7ef",
    "insertTs": "2022-09-20T08:42:52",
    "updateTs": "2022-09-20T08:42:52",
    "name": "testreseller",
    "type": "reseller",
    "status": "active",
    "contacts": [
      {
        "email": "admin@testreseller.com",
        "firstName": "Brooks",
        "lastName": "Price",
        "phone": "201-200-5904",
        "address": {
          "addressLine1": "1 Commvault",
          "city": "Tinton Fall",
          "state": "New York",
          "country": "United States",
          "postalCode": "508001"
        },
        "type": "primary"
      }
    ],
    "website": "www.testreseller.com",
    "externalId": "c36c7995-cddb-459b-b145-f6385e92b844",
    "workloadAccess": false
  }
}

{
  "data": {
    "id": "e4295015-6535-4989-9457-1ba12040a7ef",
    "insertTs": "2022-09-20T08:42:52",
    "updateTs": "2022-09-20T08:42:52",
    "name": "testreseller",
    "type": "reseller",
    "status": "active",
    "contacts": [
      {
        "email": "admin@testreseller.com",
        "firstName": "Brooks",
        "lastName": "Price",
        "phone": "201-200-5904",
        "address": {
          "addressLine1": "1 Commvault",
          "city": "Tinton Fall",
          "state": "New York",
          "country": "United States",
          "postalCode": "508001"
        },
        "type": "primary"
      }
    ],
    "website": "www.testreseller.com",
    "externalId": "c36c7995-cddb-459b-b145-f6385e92b844",
    "workloadAccess": false
  }
}

Bad Request

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  code int32

  message string

  errors object[]

  field string

  message string

{
  "error": {
    "code": 1002,
    "message": "Request validation failed!",
    "errors": [
      {
        "field": "name",
        "message": "name already exists."
      },
      {
        "field": "email",
        "message": "email already exists in Metallic."
      },
      {
        "field": "externalId",
        "message": "externalId is required and should be unique in Partner system."
      }
    ]
  }
}

{
  "error": {
    "code": 1002,
    "message": "Request validation failed!",
    "errors": [
      {
        "field": "name",
        "message": "name already exists."
      },
      {
        "field": "email",
        "message": "email already exists in Metallic."
      },
      {
        "field": "externalId",
        "message": "externalId is required and should be unique in Partner system."
      }
    ]
  }
}

Loading...