Skip to main content

Edit Partner​

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

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

OK

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
PATCH /api/v1/partner/partners

Authorization

Request

Click Edit to configure Base URL
https://api.metallic.io
Bearer Token
Body
{

  "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 PATCH '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
}'