Skip to main content
POST
/
api
/
run
/
svc
/
slug
/
fn
/
sync_slug
/
patchState
Calls a mutation at the path svc/slug/fn/sync_slug.js:patchState
curl --request POST \
  --url https://ardent-sandpiper-70.convex.cloud/api/run/svc/slug/fn/sync_slug/patchState \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "args": {
    "baggage": {
      "trace_id": "<string>",
      "traffic_type": "external"
    },
    "maxTs": 123,
    "slug": "<string>",
    "state": {
      "flows_completed": 123,
      "flows_started": 123,
      "last_activity_at": 123,
      "prs_created": 123,
      "prs_merged": 123,
      "steps_blocked": 123,
      "steps_completed": 123,
      "steps_resumed": 123,
      "steps_skipped": 123,
      "steps_started": 123,
      "current_flow": "<string>",
      "current_step": "<string>"
    }
  }
}
'
{
  "status": "success",
  "errorMessage": "<string>",
  "errorData": {},
  "value": "<unknown>"
}

Authorizations

Authorization
string
header
required

Token of the format "Bearer {token}" for normal authentication and "Convex {token}" for admin tokens.

Body

application/json
args
object
required

Response

Convex executed your request and returned a result

status
enum<string>
required
Available options:
success,
error
errorMessage
string
errorData
object
value
any