> ## Documentation Index > Fetch the complete documentation index at: https://rankspot.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update a citation > Updates the `status` of a cited page. Set to `processed` once you have acted on the citation opportunity, or back to `new` to requeue it. Archiving is a separate axis: use `DELETE` and `/unarchive`. The returned `citations` and `platforms` are all-time totals, since a write has no period to count over. ## OpenAPI ````yaml https://api.rankspot.ai/docs-json patch /v1/ai-visibility/citations/{id} openapi: 3.0.0 info: title: RankSpot Public API description: >- The RankSpot Public API gives you programmatic access to your workspace data — keywords, backlinks, competitors, planned actions, articles, and more. ## Authentication All endpoints require a Bearer API key in the `Authorization` header: ``` Authorization: Bearer ``` Generate API keys from **Settings → API Keys** in the RankSpot dashboard. Each key is scoped to a single workspace. ## Pagination List endpoints return a consistent envelope: ```json { "data": { "total": 120, "offset": 0, "limit": 20, "count": 20, "items": [...] } } ``` Use `offset` and `limit` query parameters to paginate. Default limit is **20**, maximum is **100**. ## Status codes | Code | Meaning | |------|---------| | 200 | Success | | 201 | Created | | 204 | No content (delete / unarchive) | | 400 | Validation error or business rule violation | | 401 | Missing or invalid API key | | 404 | Resource not found or belongs to another workspace | version: '1.0' contact: {} servers: - url: https://api.rankspot.ai description: Production security: [] tags: - name: AI Visibility description: >- How AI answer engines see your brand. Track prompts, read the answers ChatGPT, Perplexity and Google gave, and work through the pages they cited. Prompts are run on a daily schedule by RankSpot, so answers appear after the next run rather than on demand. - name: Articles description: >- AI-generated blog articles. Articles are created automatically when a `write_article` action is sent to generation — they cannot be created directly via the API. - name: Backlinks description: >- Backlinks discovered for your domain and your competitors' domains. Backlinks are auto-synced on a background interval and cannot be created via the API. - name: Categories description: Categories for organising actions and articles within your workspace. - name: Competitors description: >- Competitor domains tracked in your workspace. Once added, keywords and backlinks for each competitor are fetched asynchronously on a background sync interval. - name: Forum Opportunities description: >- Forum threads and community posts surfaced as potential link-building or engagement opportunities. - name: Keywords description: >- SEO keywords tracked in your workspace, enriched with search volume, competition, and AI-generated relevance scores. - name: People Also Ask description: >- "People also ask" questions discovered from search results for your tracked keywords. - name: Actions description: >- The SEO work planned for your workspace. Each action carries a `type` saying what kind of work it is and which target it points at — see `POST /v1/actions` for the full list. Only `write_article` can be turned into an article; the rest are a person's job. Create actions yourself or let RankSpot generate them. - name: Research description: >- Live lookups against the open web: a Google search and a page fetch. The only endpoints here that spend credits per call. Neither response reports what it cost — the charge is real, and your remaining balance is visible in the RankSpot dashboard. Returns 402 when the workspace is out of credits. - name: Search Console description: >- Google Search Console performance data — clicks, impressions, CTR, and average position for your connected property. Requires GSC to be connected from the RankSpot dashboard. - name: Workspace description: >- Who the workspace is: brand, domain, what the business does and who it sells to. Read this first — the rest of the API returns opportunities that only mean something in the context of a particular business. paths: /v1/ai-visibility/citations/{id}: patch: tags: - AI Visibility summary: Update a citation description: >- Updates the `status` of a cited page. Set to `processed` once you have acted on the citation opportunity, or back to `new` to requeue it. Archiving is a separate axis: use `DELETE` and `/unarchive`. The returned `citations` and `platforms` are all-time totals, since a write has no period to count over. operationId: AiCitationsController_update parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAiCitationDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AiCitationDto' '404': description: Cited page not found or belongs to another workspace. security: - bearer: [] components: schemas: UpdateAiCitationDto: type: object properties: status: description: >- Mark the page as handled, or put it back on the worklist. Archiving is a separate axis: use `DELETE` and `/unarchive`. allOf: - $ref: '#/components/schemas/ProcessedStatus' required: - status AiCitationDto: type: object properties: id: type: string example: 3f1c2b4e-8d5a-4a2f-9c3e-7b1d6a5e4c20 url: type: string example: https://rankspot.ai/blog/ai-seo-tools/ domain: type: string example: rankspot.ai title: type: string nullable: true example: The 12 best AI SEO tools description: Title as the citing platform reported it. isOwnDomain: type: boolean example: true description: The page is on your own domain. status: allOf: - $ref: '#/components/schemas/ProcessedStatus' firstSeenAt: format: date-time type: string description: >- When this page was first and last cited, ever. Not clipped to the requested period. lastSeenAt: format: date-time type: string citations: type: number example: 14 description: >- Responses in the period that cited this page. One response can cite a page at most once, so this is both the citation count and the number of answers behind it. platforms: type: array description: Platforms that cited this page in the period. items: $ref: '#/components/schemas/AiPlatform' required: - id - url - domain - title - isOwnDomain - status - firstSeenAt - lastSeenAt - citations - platforms ProcessedStatus: type: string enum: - new - processed AiPlatform: type: string enum: - chatgpt - perplexity - google_ai_overview - google_ai_mode securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ````