Relativity

Relativity Relativity Notifications Module v1 API

The Relativity Notifications Module v1 API from Relativity — 1 operation(s) for relativity notifications module v1.

GitHub OpenAPI

Documentation

📖
Documentation
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/rate-limits/relativity-rate-limits.yml
📖
Documentation
https://platform.relativity.com/RelativityOne/Content/Relativity_Platform/Platform_APIs.htm
📖
GettingStarted
https://platform.relativity.com/RelativityOne/Content/Getting_Started/Basic_REST_API_concepts.htm
📖
Documentation
https://help.relativity.com/RelativityOne/Content/Management_Console/Cost_Explorer.htm

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/openapi/relativity-relativity-notifications-module-v1-api-openapi.yml

Other Resources

🔗
Plans
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/plans/relativity-plans-pricing.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/finops/relativity-finops.yml
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/graphql/relativity-graphql.md

OpenAPI Specification

relativity-relativity-notifications-module-v1-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Analytics.Conceptual.Service.Interfaces.Public.V1 AnnotationService Relativity Notifications Module v1 API
  description: Analytics.Conceptual.Service.Interfaces.Public
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: Relativity Notifications Module v1
paths:
  /relativity-notifications/v1/workspaces/-1/notifications/email:
    post:
      tags:
      - Relativity Notifications Module v1
      description: '[Public] IEmailNotificationsManager - '
      operationId: Relativity.Notifications.V1.IEmailNotificationsManager.SendEmailNotificationAsync
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailNotificationRequest'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailNotificationResponse'
components:
  schemas:
    EmailNotificationStatus:
      title: EmailNotificationStatus
      type: object
      properties:
        Recipient:
          type: string
        IsSent:
          type: boolean
        Message:
          type: string
    EmailNotificationRequest:
      title: EmailNotificationRequest
      type: object
      properties:
        Sender:
          type: string
        Recipients:
          type: array
          items:
            type: string
        Subject:
          type: string
        Body:
          type: string
        IsBodyHtml:
          type: boolean
    EmailNotificationResponse:
      title: EmailNotificationResponse
      type: object
      properties:
        EmailNotifications:
          type: array
          items:
            $ref: '#/components/schemas/EmailNotificationStatus'
  parameters:
    x-csrf-header:
      name: x-csrf-header
      in: header
      description: ''
      required: true
      schema:
        type: string
        default: '-'