'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
| Status Code | Error Type | Field | Description |
| ----------- | ---------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400 | Validation Error | unique\_id | This field is required and its may not be blank.
User not exist or invalid unique id.
Ensure this field has no more than 255 characters.
|
| 400 | Validation Error | upgrade\_to | This field is required and its may not be blank.
Invalid upgrade option, Choose a valid one.
|
| 400 | Validation Erorr | api\_place\_genealogy | This field is required and its may not be blank.
Choose a valid option.
|
| 403 | Request Failed | | User role is already upgraded.
User already have a member role.
User already have a preferred customer role.
Free user place genealogy disabled, can't upgrade user role.
Free package for user role upgrade is not created.
User role upgrade option not found.
Created free package is not a customer privilaged package.
Created free package is not a member privilaged package.
|
## Downgrade User Role
`POST` `https://///downgrade/user-role/`
This API endpoint will downgrade a user role from member to preferred customer or to customer.
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| apikey\* | string | apikey |
| Authorization\* | string | Bearer access token |
#### Request Body
| Name | Type | Description |
| -------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| unique\_id\* | string | user unique id |
| downgrade\_to\* | string | Downgrade options, possible values are:
Customer - Downgrade user role from member to customer.
Preferred Customer - Downgrade user role from member to preferred customer
|
| api\_block\_user\* | string | Block the user with role downgrade, Possible values are:
True - Block user account.
False - Do not block.
|
{% tabs %}
{% tab title="200 " %}
```markup
HTTP/1.1 200 OK
Content-Type: application/json
Body:
{
"status_code": 200,
"errors": {},
"data": {}
}
```
{% endtab %}
{% endtabs %}
#### Sample Code
**Node**
```php
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://///downgrade/user-role/',
'headers': {
'apikey': '',
'Authorization': 'Bearer '
},
formData: {
'unique_id': '',
'downgrade_to': ''
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
```
**PHP**
```php
'https://///downgrade/user-role/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('unique_id' => '','downgrade_to' => ''),
CURLOPT_HTTPHEADER => array(
'apikey: ',
'Authorization: Bearer '
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
**Error Responses**
| Status Code | Error Type | Field | Description |
| ----------- | ---------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 400 | Validation Error | unique\_id | This field is required and its may not be blank.
User not exist or invalid unique id.
Ensure this field has no more than 255 characters.
|
| 400 | Validation Error | downgrade\_to | This field is required and its may not be blank.
Invalid downgrade option, Choose a valid one.
|
| 400 | Validation Erorr | api\_block\_user | Choose a valid option. |
| 403 | Request Failed | | User already have a downgraded role.
User already have a customer role.
User already have a preferred customer role.
Somthing went wrong.
|
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://api.epixelsoftware.help/user-roles.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.