API v1
v1
View as Markdown

Change the status of a support request

PUT /api/v1/admin/support-requests/{supportRequest}/status

Move a request to another status without writing to the person.

Only an administrator of this instance can use these endpoints, and only with an API key that carries the administration scope by name. Anybody else, including an administrator whose key does not carry it, gets 404 as though the endpoint did not exist.

Parameters

Sent as JSON. Anything not listed here is ignored.

supportRequest uuid Required

The id of the request, of any account on the instance.

status string Required

The status to move to: to_handle, waiting_on_user or solved. Any other value answers 422 on status.

Returns

The support request object as it stands now, without its messages and its status changes. Read the request to get them.

data object

The support request.

data.type string

Always support_request. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.

data.id string

The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.

data.attributes object

Everything the record holds.

data.attributes.reference string

The reference the person quotes when writing to the support team, such as MON-482913.

data.attributes.account_id integer

The account the request was opened from.

data.attributes.user object

Who asked.

data.attributes.user.name string

The name of the person who opened the request, or null once their user is deleted.

data.attributes.user.email string

Where replies are emailed, or null once their user is deleted.

data.attributes.category string

What the request is about: feature, billing, email, question or technical.

data.attributes.subject string

The title the request was opened with.

data.attributes.status string

to_handle when the person is waiting for an answer, waiting_on_user when the team is, or solved.

data.attributes.status_label string

The status as the administrators read it, in the language of the signed in administrator.

data.attributes.application_version string

The version of the application the request was opened from.

data.attributes.locale string

The language the person was using when they opened it.

data.attributes.opened_at timestamp

When the request was opened, as a count of seconds since 1970.

data.attributes.last_activity_at timestamp

When anybody last wrote in it, the person who asked or the support team, as a count of seconds since 1970. A change of status alone does not move it.

data.attributes.solved_at timestamp

When it was marked as solved, as a count of seconds since 1970, or null while it is open.

data.links object

Where to find this record.

data.links.self string

The absolute address this record is read from.

Rate limit

Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.

PUT
curl https://my.monicahq.com/api/v1/admin/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17/status \
-X PUT \
-H "Authorization: Bearer $MONICA_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"status": "solved"
}'
const response = await fetch('https://my.monicahq.com/api/v1/admin/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17/status', {
method: 'PUT',
headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
body: JSON.stringify({
status: 'solved',
}),
})
const data = await response.json()
$response = Http::withToken($token)->put('https://my.monicahq.com/api/v1/admin/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17/status', [
'status' => 'solved',
]);
Response 200
{
"data": {
"type": "support_request",
"id": "7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17",
"attributes": {
"reference": "MON-482913",
"account_id": 12,
"user": {
"name": "Michael Scott",
"email": "[email protected]"
},
"category": "question",
"subject": "My conference room reminder never arrived",
"status": "solved",
"status_label": "Solved",
"application_version": "5.0.0",
"locale": "en",
"opened_at": 1791547200,
"last_activity_at": 1791554400,
"solved_at": 1791554400
},
"links": {
"self": "https://my.monicahq.com/api/v1/admin/support-requests/7c1e4a92-5b3d-4f08-a6e1-93d2c8b05f17"
}
}
}

Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.