Creating a new MSP partner (old)

URI - POST

To use this endpoint, send a POST request to create a new MSP Partner: /msp/msp-partner

Note - This endpoint will be deprecated by 15 June 2025 and will be replaced by the /msp/msp-partners-extended endpoint. See Creating a new MSP partner.

Request

The request includes HTTP headers (obtained in the authentication/authorization process and used to sign the request) with a request body in JSON format.

Note - The request body must include the name of the MSP.

Request Headers

Header	Type	Required	Format	Description/Sample
x-av-req-id	String	Yes	UUID – generated and supplied on the request	d290f1ee-6c54-4b01-90e6-d701748f0851
x-av-token	String	Yes	Token obtained in the authentication sequence	tkn8546ffffggd9d8934593
x-av-app-id	String	Yes	Application ID provided by Avanan	myapp29
x-av-date	String	Yes	Date-time in GMT	'2016-08-29T09:12:33.001Z'
x-av-sig	String	Yes	Calculated signature	tkn8jmveolrrtertr9d8934593

Request Body

All applicable request parameters are posted on the request body JSON:

Copy

{
    "requestData": {
          "name": "string"
      } 
}

Request Body Parameters

The JSON parameters:

Parameter	Type	Required	Format	Description/Sample
name	String	Yes		Name of the new MSP

Request sample (CURL) format

This request sample shows URI base in USA region. For URI base in other regions, see MSP Types.

Copy

curl -X POST -H "Accept: application/json" \
    -H "x-av-req-id: d290f1ee-6c54-4b01-90e6-d701748f0851" \
    -H "x-av-token: tkn8546ffffggd9d8934593" \
    -H "x-av-app-id: myapp29" \
    -H "x-av-date: 2016-08-29T09:12:33.001Z" \
    -H "x-av-sig: tkn8jmveolrrtertr9d8934593" \
    https://smart-api-production-1-us.avanan.net/v1.0/msp/msp-partners

Response

The response obtained from the service includes an HTTP response code and JSON formatted structure. The structure consists of a responseEnvelope structure and a responseData object that holds the details of the newly created MSP.

Response Structure

A valid response from the service in JSON:

Copy

{
  "responseEnvelope": {
    "requestId": "string",
    "responseCode": 0,
    "responseText": "",
    "additionalText": "",
    "recordsNumber": 0,
    "scrollId": "string"
  },
  "responseData": {
    "id": 0,
    "name": "string"
  }
}

Response Parameters

The response parameters:

Parameter		Type	Description
responseEnvelope		Object	A container of metadata properties
	requestId	String	Request ID (from the request header x-av-req-id value)
	responseCode	Integer	0 = Success Other values = Failure
	responseText	String	The text value of the response
	additionalText	String	Additional information
	recordsNumber	Integer	Number of records in the response
	totalRecordsNumber	Integer	Total number of records
	scrollId	String	A unique ID used to scroll through data
responseData		Object	Array of tenants
	id	Integer	Unique ID of the MSP
	name	String	Name of the MSP

Response Sample

A valid response from the service:

Copy

{
  "responseEnvelope": {
    "requestId": "cc7796ac-6235-4a06-b7e9-6abc557976f6",
    "responseCode": 0,
    "responseText": "Success",
    "additionalText": "",
    "recordsNumber": 1,
    "totalRecordsNumber": 1,
    "scrollId": ""
  },
  "responseData": {
    "Id": 16,
    "name": "Acme MSP"
}