Skip to main content
PATCH
/
api
/
v1
/
apps
/
{appId}
/
routes
/
{routeId}
Update App route
curl --request PATCH \
  --url https://app.promptingco.com/api/v1/apps/{appId}/routes/{routeId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "path": "<string>",
  "targetType": "product_document",
  "targetId": "<string>"
}
'
{
  "ok": true,
  "data": {
    "id": "<string>",
    "appId": "<string>",
    "path": "<string>",
    "targetType": "product_document",
    "targetId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "target": {
      "id": "<string>",
      "title": "<string>",
      "filePath": "<string>",
      "sourceUrl": "<string>",
      "status": "<string>",
      "type": "<string>",
      "redirectToUrl": "<string>",
      "productId": "<string>"
    },
    "product": {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>"
    }
  }
}

Authorizations

x-api-key
string
header
required

Organization-scoped API key. Available scopes:

  • content:read: Read site pages, markdown content, and llms.txt files
  • content:write: Create, update, and delete site pages and content
  • prompts:read: Read prompts, topics, and prompt analysis results
  • prompts:write: Create, update, archive prompts
  • simulations:read: Read agent-simulation tasks, runs, environments, and analytics
  • simulations:write: Create and trigger simulation runs
  • logs:read: Read AI-traffic logs and request-level audit events
  • analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
  • products:read: Read product metadata and competitor data
  • products:write: Update product settings and competitor lists

Path Parameters

appId
string
required
Minimum string length: 1
routeId
string
required
Minimum string length: 1

Body

application/json
path
string
Required string length: 1 - 2048
Pattern: ^\/?[^?#\s]*$
targetType
enum<string>
Available options:
product_document
targetId
string
Minimum string length: 1

Response

Successful response

ok
enum<boolean>
required
Available options:
true
data
object
required