Osano

Osano Subject Rights Portal API

The subjectRightsPortal API from Osano — 2 operation(s) for subjectrightsportal.

GitHub OpenAPI

Operations 3

GET /v1/subject-rights/requests/{requestId}/portal-messages Get Portal Messages #
POST /v1/subject-rights/requests/{requestId}/portal-messages Create Portal Message #
PATCH /v1/subject-rights/requests/{requestId}/portal-messages/{messageId} Update Portal Message #

Documentation

📖
Documentation
https://developers.osano.com/customer-rest-api/developer-api-doc
📖
APIReference
https://developers.osano.com/customer-rest-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/authentication/osano-authentication.yml
📖
Documentation
https://developers.osano.com/uc/
📖
APIReference
https://developers.osano.com/uc/core-api/openapi

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/openapi/osano-subjectrightsportal-api-openapi.yml

SDKs

📦
SDK
https://developers.osano.com/uc/js-sdk/

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/errors/osano-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/data-model/osano-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/conventions/osano-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/osano-subjectrightsportal-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

osano-subjectrightsportal-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Osano API Reference Subject Rights Portal API
  version: 1.0.0
  description: '# Introduction

    This is the Osano API.'
  x-logo:
    url: https://www.osano.com/hubfs/Imported%20images/Logo.svg
    altText: Osano
servers:
- url: https://api.osano.com
  description: Production API
security:
- ApiKeyAuth: []
tags:
- name: subjectRightsPortal
  x-displayName: Subject Rights Portal
paths:
  /v1/subject-rights/requests/{requestId}/portal-messages:
    get:
      summary: Get Portal Messages
      description: Get the messages for a specific request
      tags:
      - subjectRightsPortal
      operationId: getPortalMessages
      parameters:
      - name: requestId
        required: true
        in: path
        description: The identifier of the Subject Rights request
        schema:
          type: string
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/nextTokenParam'
      - $ref: '#/components/parameters/afterParam'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortalMessagesResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      summary: Create Portal Message
      description: Create a new message for a specific request
      tags:
      - subjectRightsPortal
      operationId: postPortalMessage
      parameters:
      - name: requestId
        required: true
        in: path
        description: The identifier of the Subject Rights request
        schema:
          type: string
      requestBody:
        description: The message to add to the request conversation
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PortalMessage'
      responses:
        '204':
          description: Success
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/subject-rights/requests/{requestId}/portal-messages/{messageId}:
    patch:
      summary: Update Portal Message
      description: Update a message for a specific request
      tags:
      - subjectRightsPortal
      operationId: patchPortalMessage
      parameters:
      - name: requestId
        required: true
        in: path
        description: The identifier of the Subject Rights request
        schema:
          type: string
      - $ref: '#/components/parameters/messageIdParam'
      requestBody:
        description: The read status to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchPortalMessage'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchPortalMessagesResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    limitParam:
      name: limit
      required: false
      in: query
      description: The number of items to return.
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 500
        default: 100
    afterParam:
      name: after
      required: false
      in: query
      description: Specify UTC date and time in ISO-8601 format (e.g. 2021-01-01T00:00:00Z) to filter items created after this date.
      schema:
        type: string
    messageIdParam:
      name: messageId
      required: true
      in: path
      description: The id of the message to update
      schema:
        type: string
    nextTokenParam:
      name: next
      required: false
      in: query
      description: The pagination token from the previous request.
      schema:
        type: string
  schemas:
    PatchPortalMessagesResponse:
      type: object
      additionalProperties: false
      required:
      - messageId
      - updated
      properties:
        messageId:
          type: number
        updated:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      additionalProperties: true
      properties:
        message:
          type: string
    PortalMessagesResponse:
      type: object
      additionalProperties: false
      required:
      - items
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PortalMessagesList'
        next:
          type: string
          description: A token which may be appended to subsequent requests to retrieve the next page of results, i.e. ?next=...
    PortalMessagesList:
      type: object
      additionalProperties: false
      required:
      - messageId
      - content
      - sent
      - read
      - source
      properties:
        messageId:
          type: number
        content:
          type: string
        sent:
          type: string
          format: date-time
        read:
          type: boolean
        source:
          type: string
        attachments:
          type: array
          items:
            type: object
            properties:
              messageAttachmentId:
                type: number
              fileName:
                type: string
              fileType:
                type: string
              fileExt:
                type: string
    PatchPortalMessage:
      type: object
      additionalProperties: false
      required:
      - read
      properties:
        read:
          type: boolean
    PortalMessage:
      type: object
      additionalProperties: false
      required:
      - content
      properties:
        content:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-osano-api-key
x-tagGroups:
- name: General
  tags:
  - cmp
  - cmpRules
  - connectors
  - dsar
  - dataDiscovery
  - dsarActionItems
  - subjectRightsPortal
  - customerInsights