masstack

V1
V2
API Overview Resources Schemas

Custom Information

Operations related to custom information

Parameters

Name In Type Required Description
limit query integer(int64) false Limit of results in the response
offset query integer(int64) false Offset applied to results for pagination
sort query string false The fields by which the results will be sorted. It can be a list of fields separated by commas. A suffix must be added:
* “:asc” to indicate an ascending order.
* “:desc” to indicate a descending order.
Authorization header string true Bearer token

Request example

1
2
3
4
5


curl -X GET https://dealers.masstack.com/v2/custom-information?limit='20'&offset='0'&sort='name:asc,id:desc' \
  -H "Accept: application/json" \
  -H "Authorization: string"

Responses

Code Meaning Description Schema
200 OK Successfully returned the list of custom information variable definitions CustomInformationPaginatedResponse
400 Bad Request Bad Request ApiErrorResponse
401 Unauthorized Unauthorized ApiErrorResponse
500 Internal Server Error Internal Error ApiErrorResponse

Parameters

Name In Type Required Description
Authorization header string true Bearer token
body body CustomInformationInsertionRequest true Custom information variable definition creation request

Request body - instance of CustomInformationInsertionRequest

1
2
3
4

{
  "name": "Funnel",
  "description": "Funnel Access"
}
Name Type Required Description
name string true Name of the custom information variable
description string¦null true Description of the custom information variable

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


curl -X POST https://dealers.masstack.com/v2/custom-information \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: string" \
 --data-raw "{
  'name': 'Funnel',
  'description': 'Funnel Access'
}"

Responses

Code Meaning Description Schema
201 Created Successfully created CustomInformationResponse
400 Bad Request Bad Request ApiErrorResponse
401 Unauthorized Unauthorized ApiErrorResponse
500 Internal Server Error Internal Error ApiErrorResponse

Parameters

Name In Type Required Description
id path string true Custom information variable definition ID
Authorization header string true Bearer token

Request example

1
2
3
4
5


curl -X GET https://dealers.masstack.com/v2/custom-information/{id} \
  -H "Accept: application/json" \
  -H "Authorization: string"

Responses

Code Meaning Description Schema
200 OK Successfully returned the custom information variable definition CustomInformationResponse
400 Bad Request Bad Request ApiErrorResponse
401 Unauthorized Unauthorized ApiErrorResponse
404 Not Found Not Found ApiErrorResponse
500 Internal Server Error Internal Error ApiErrorResponse

Parameters

Name In Type Required Description
id path string true Custom information variable definition ID
Authorization header string true Bearer token
body body CustomInformationUpdateRequest true Custom information variable definition update request

Request body - instance of CustomInformationUpdateRequest

1
2
3
4

{
  "name": "Funnel",
  "description": "Funnel Access"
}
Name Type Required Description
name string true Name of the custom information variable
description string¦null true Description of the custom information variable

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


curl -X PUT https://dealers.masstack.com/v2/custom-information/{id} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: string" \
 --data-raw "{
  'name': 'Funnel',
  'description': 'Funnel Access'
}"

Responses

Code Meaning Description Schema
204 No Content Successfully updated None
400 Bad Request Bad Request ApiErrorResponse
401 Unauthorized Unauthorized ApiErrorResponse
404 Not Found Not Found ApiErrorResponse
500 Internal Server Error Internal Error ApiErrorResponse

Parameters

Name In Type Required Description
id path string true Custom information variable definition ID
Authorization header string true Bearer token

Request example

1
2
3
4
5


curl -X DELETE https://dealers.masstack.com/v2/custom-information/{id} \
  -H "Accept: application/json" \
  -H "Authorization: string"

Responses

Code Meaning Description Schema
204 No Content Successfully deleted None
400 Bad Request Bad Request ApiErrorResponse
401 Unauthorized Unauthorized ApiErrorResponse
404 Not Found Not Found ApiErrorResponse
500 Internal Server Error Internal Error ApiErrorResponse

Endpoints

Default

    Loads

      Actors

        Dealers

          Custom Information

            Commercial Structure

              Brands