update_endpoint
Partially updates an API endpoint doc; send only fields to change (same fields as Create Endpoint). Any update moves a non-pending endpoint back to draft (state 1), so republish with Update Endpoint State. Requires READ_WRITE permission. Only works for type 4/5 items (otherwise 400 "Wrong Route"). Invalid fields return 400 with the validation message. Body fields:
name (string, optional) - Endpoint title shown in docs. urlName (string, optional) - New URL slug; made unique among siblings. Left unchanged if omitted (it is not re-derived from name). requestType (string, optional) - HTTP method: GET, POST, PUT, PATCH, DELETE, etc. URL (string, optional) - Request URL (may contain {{variables}}). description (string, optional) - Endpoint description (HTML/text). body (object, optional) - Request body definition, e.g. {"type":"JSON","raw":{"rawType":"JSON","value":"{...}"}}; type can be none, JSON, TEXT, XML, HTML, multipart/form-data, application/x-www-form-urlencoded. headers (object, optional) - Headers keyed by name: {"Authorization":{"checked":"true","value":"Bearer {{token}}","description":""}}. params (object, optional) - Query params keyed by name, same shape as headers. pathVariables (object, optional) - Path variables keyed by index: {"0":{"checked":"notApplicable","key":"id","value":"","description":"Payment id"}}. bodyDescription (object, optional) - Per-field body docs: {"amount":{"value":100,"type":"number","description":"Amount in cents"}}. sampleResponse (array, optional) - Sample responses: [{"title":"Success","status":200,"description":"","data":{...}}]. authorizationData (object, optional) - Auth config object (or null). preScript (string, optional) - Pre-request JavaScript. postScript (string, optional) - Post-response test JavaScript. docViewData (array, optional) - Order of doc sections, e.g. [{"type":"host"},{"type":"body"},...]. state (number, optional) - 0 pending, 1 draft, 2 approved, 3 rejected. Accepted, but the server sets state 1 (draft) on every update unless the endpoint is currently pending (0). Use Update Endpoint State to publish. uniqueTabId (string, optional) - Optional browser tab id used only to suppress the realtime socket echo to the calling tab; agents can omit it. PUT https://api.docstar.io/orgs/:orgId/endpoints/:endpointId
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"orgId": "<orgId>",
"endpointId": "<endpointId>"
},
"name": "update_endpoint"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| URL | No | e.g. https://api.example.com/v1/payments | |
| body | No | e.g. {"type":"JSON","raw":{"rawType":"JSON","value":"{\"amount\":100,\"currency\":\"USD\"}"}} | |
| name | No | e.g. Create Payment | |
| orgId | Yes | The orgId path variable | |
| params | No | e.g. {} | |
| headers | No | e.g. {"Content-Type":{"checked":"true","value":"application/json","description":""}} | |
| endpointId | Yes | The endpointId path variable | |
| description | No | e.g. Creates a new payment for a customer | |
| requestType | No | e.g. POST | |
| pathVariables | No | e.g. {} | |
| sampleResponse | No | e.g. [{"title":"Success","status":200,"description":"","data":{"id":"pay_1"}}] |