Status
4 min
The status endpoint
POST https://www.regpack.com/reg/api2/statuses/The status endpoint allows you to create statuses, which can then be applied to users with the user api actions.
Basic structure
Each call to the API requires action and a group_id.
Name | Type | Required | Description |
|---|---|---|---|
action | string | true | This describes what you would like to do with the api. For status, the only action is create. |
group_id | integer | true | This designates which project the change should be applied to. API-id in the header must be part of the organization that owns the group. |
doc | JSON | true | This is the status data you would like to include in the request, formatted as JSON. |
Example call
This would be an example cURL which creates a status.
curl -X POST "https://www.regpack.com/reg/api2/statuses/" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Api-Id: 15263" \
-H "Api-user: [email protected]" \
-H "Api-Token: cd2e514f-7gab-3cde-62fg-51abcd4e7362" \
-d '{
"action": "create",
"group_id": 100909072,
"doc": {
"status_name": "cancellation_risk",
"color": "#800000",
"is_excluded": 0
}
}Example response
{
"msg": "Status created successfully.",
"msg_type": "info",
"status_id": 76867,
"success": true
}