update_request - Qobra public API documentation

Change an existing request: its title, status, assignee, topic, members or linked statements. Pass only what changes: an omitted argument leaves that part as it is, and a call that changes nothing writes nothing. member_ids and statements are whole sets, not additions — call get_request first and send back everything to keep, or what is missing from your list is removed. A statement the request already links, sent back with the same record, is kept as it is. A closed request can be edited only in a call that reopens it (status open); a call can also make its changes and close the request in one go. The assignee and the topic can be changed here but not removed. Removing yourself from member_ids is allowed, and you then lose the request unless your role reaches it another way. Available only where the Qobra write tools beta is enabled. Every write is recorded in the audit trail as the Qobra MCP agent.

Example

To add a member and close the request in one call, read the request with get_request first, then send back every member and statement to keep alongside the new one:

{
  "request_id": "6650f1c2a8b4e1d2c3f4a5b6",
  "status": "closed",
  "member_ids": ["6650f1c2a8b4e1d2c3f4a001", "6650f1c2a8b4e1d2c3f4a002"],
  "statements": [
    { "user_id": "jane.doe@example.com", "period": "2026-03" }
  ]
}

Omit member_ids and statements entirely when they don’t change.

Parameters

Body

string

required

Id of the request to change — the id list_requests or create_request returns.

string

New title of the request. Omit to keep it.

string

open to reopen the request, closed to close it as resolved. Omit to keep it. One of: open, closed.

string

Id of the person to hand the request to — the id list_users returns. They become a member and are notified it is theirs. Omit to keep the assignee.

string

Id of the topic to file the request under — one of requests.topics from get_company_settings. Omit to keep it.

string[]

The request’s whole membership — the ids list_users returns. Anyone left out is removed, anyone new is notified they were added, and the assignee stays a member whatever the list. Omit to leave the members as they are.

object[]

The whole set of statements the request is about — one user in one month each, optionally narrowed to one of its records. A statement left out is unlinked, and an empty list unlinks them all. Omit to leave them as they are.

Show object properties

string

required

Id or exact email of the user whose statement it is.

string

required

Month of the statement, as YYYY-MM (e.g. ‘2026-03’).

object

The one record of this statement the request is about — a deal, most often. Omit to link the statement as a whole.

Show object properties

string

required

Id of the scope the record was frozen into — the id of one of get_statement_compensation’s scopes.

string

required

Id of the record — the record_id list_statement_records returns for that scope.

Response

Body

object

The request as it now stands — the same row list_requests returns, unchanged when the call changed nothing.

Show object properties

string

Deep link to open this request in the Qobra web app.

string

The #-style reference shown in the UI.

string

object

Admin-configured category used to classify the request; null if none.

Show object properties

string

open (awaiting handling) or closed (resolved). One of: open, closed.

object

Show object properties

string

object

Show object properties

string

object

Show object properties

string

object[]

Show object properties

string

object[]

Show object properties

object

Show object properties

string

object

The linked deal/record when the statement is record-based; null otherwise.

Show object properties

string

​Example

​Parameters

​Response

Example

Parameters

Response