API Overview Resources Schemas

Customer Special Treatment

Access to customers special treatment

Get customer special treatment

Returns the special treatment assigned to the customer. Currently, only one value is allowed.

GET /orgs/{org_id}/customers/{customer_id}/special-treatment

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
customer_id	path	string(uuid)	true	Customer identifier

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/special-treatment \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	Special treatment assigned to the customer	CustomerSpecialTreatment
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	Resource not found	ErrorResponse
409	Conflict	Conflict	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse

Set customer special treatment

Creates or updates the special treatment assigned to a customer. The special treatment is associated with a single customer. Only one special treatment for customer is handled at the moment

PUT /orgs/{org_id}/customers/{customer_id}/special-treatment

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
customer_id	path	string(uuid)	true	Customer identifier
body	body	CustomerSpecialTreatment	true	‘none’

Request body - JsonObject

1
2
3
4
5


{
  "values": [
    "vip"
  ]
}

Name	Type	Required	Description
anonymous	SpecialTreatmentValues	false	none

Name	Type	Required	Description
anonymous	object	false	none
» values	[string]	false	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11



curl -X PUT https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/special-treatment \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY" \
 --data-raw "{
  'values': [
    'vip'
  ]
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	Customer special treatment set successfully	None
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	Resource not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Delete customer special treatment

Deletes the special treatment assigned to the customer

DELETE /orgs/{org_id}/customers/{customer_id}/special-treatment

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
customer_id	path	string(uuid)	true	Customer identifier

Request example

1
2
3
4
5



curl -X DELETE https://customers.sta.masstack.com/v4/orgs/telco/customers/123e4567-e89b-12d3-a456-556642440000/special-treatment \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
204	No Content	Successful operation	None
400	Bad Request	Invalid request body	ErrorResponse
401	Unauthorized	Unauthorized	ErrorResponse
403	Forbidden	Forbidden resource	ErrorResponse
404	Not Found	Resource not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
503	Service Unavailable	Service unavailable	ErrorResponse
504	Gateway Time-out	Repository timeout	ErrorResponse

Endpoints

Accounts

External accounts

Customers

External customers