SymDocs
Workspace API
All productsSym Workspace APISym Passes MCP
Supportjoinsym.com ↗
Sym Workspace API

Create an app browser Pass

Create an app browser Pass. Account API key only; a workspace key, workspace administrator role or attached browser Pass is not account authority.

API 2.7.0 · Published service contract ↗

Request

Base URL: https://app.sym.so/v1

Authentication: account_bearer. Required scope: browser_passes:write.

POST /account/bridge-apps/{app_id}/browser-passes

Create an app browser Pass. Account API key only; a workspace key, workspace administrator role or attached browser Pass is not account authority.

ParameterTypeDescription
app_id
path · required
stringRequired app_id path identifier.
Request
curl --fail-with-body -X POST "https://app.sym.so/v1/account/bridge-apps/$APP_ID/browser-passes" \
  -H "Authorization: Bearer $SYM_ACCOUNT_API_KEY" \
  -H "Content-Type: application/json" \
  --data "{\"name\":\"Example browser access\",\"profiles\":[\"ext:example\"],\"scope\":\"read\",\"request_id\":\"11111111-1111-4111-8111-111111111111\",\"issued_at\":1800000000000}"
Response 200
{
  "ok": true,
  "deviceId": "11111111-1111-4111-8111-111111111111",
  "result": {
    "receipt": {
      "id": "11111111-1111-4111-8111-111111111111",
      "status": "completed",
      "result": {
        "pass": {
          "id": "11111111-1111-4111-8111-111111111111",
          "name": "Example browser access",
          "scope": "read",
          "profiles": [
            "ext:example"
          ]
        }
      }
    },
    "replayed": false
  }
}

Request schema

Complete input schema
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "profiles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "maxItems": 50,
      "uniqueItems": true
    },
    "scope": {
      "type": "string",
      "enum": [
        "read",
        "full"
      ]
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "issued_at": {
      "type": "integer",
      "description": "Unix milliseconds within 60 seconds. Example timestamp is illustrative; generate a fresh value."
    }
  },
  "required": [
    "name",
    "profiles",
    "scope",
    "request_id",
    "issued_at"
  ],
  "additionalProperties": false
}

Authorization

Credential contract
{
  "type": "account_bearer",
  "scope": "browser_passes:write",
  "transport": "Authorization: Bearer <account_api_key>",
  "workspace_key_compatible": false
}

Errors

StatusDescription
400The request body or parameters are invalid.
401Required account/workspace credential missing, wrong type, expired or revoked.
403Scope, matching account ownership or current target access denied.
404The resource is missing or intentionally hidden by authorization.
409App management disabled, app busy, stale state or conflicting request. Refresh state; do not blindly retry.
429The key exceeded its current rate limit.
503Control service, worker or device unavailable. A mutation may have an unknown outcome.

Usage notes