Version 2.23 is deprecated. Upgrade to a newer supported version.
Ctrlk
Contact support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Subscriptions

Use to manage notifications subscriptions.

Get current users subscriptions

get

Get current users subscriptions

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

A Subscription

application/json
channelsstring[]Required
idstringOptional
get/api/v1/subscriptions
GET /api/v1/subscriptions HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "events": [
      {
        "category": "cat1",
        "types": [
          "type1",
          "type2"
        ]
      },
      {
        "category": "cat2",
        "types": [
          "type3",
          "type4"
        ]
      }
    ],
    "channels": [
      "email",
      "email1"
    ],
    "id": "text"
  }
]

Create user subscription

post

Create user subscription

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
channelsstring[]Required
idstringOptional
Responses
200

Subscription created successfully

application/json
channelsstring[]Required
idstringOptional
post/api/v1/subscriptions
POST /api/v1/subscriptions HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "id": 1234,
  "events": [
    {
      "category": "cat1",
      "types": [
        "type1",
        "type2"
      ]
    },
    {
      "category": "cat2",
      "types": [
        "type3",
        "type4"
      ]
    }
  ],
  "channels": [
    "email",
    "email1"
  ]
}
{
  "id": 1234,
  "events": [
    {
      "category": "cat1",
      "types": [
        "type1",
        "type2"
      ]
    },
    {
      "category": "cat2",
      "types": [
        "type3",
        "type4"
      ]
    }
  ],
  "channels": [
    "email",
    "email1"
  ]
}

Update user subscription

put

Update user subscription

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
idstringRequired

Subscription id

Body
channelsstring[]Required
Responses
200

Subscription created successfully

application/json
channelsstring[]Required
idstringOptional
put/api/v1/subscriptions/{id}
PUT /api/v1/subscriptions/{id} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "events": [
    {
      "category": "cat1",
      "types": [
        "type1",
        "type2"
      ]
    },
    {
      "category": "cat2",
      "types": [
        "type3",
        "type4"
      ]
    }
  ],
  "channels": [
    "email",
    "email1"
  ]
}
{
  "id": 1234,
  "events": [
    {
      "category": "cat1",
      "types": [
        "type1",
        "type2"
      ]
    },
    {
      "category": "cat2",
      "types": [
        "type3",
        "type4"
      ]
    }
  ],
  "channels": [
    "email",
    "email1"
  ]
}

Delete user subscription

delete

Delete user subscription

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
idstringRequired

Subscription id

Responses
204

Subscription deleted successfully

No content
delete/api/v1/subscriptions/{id}
DELETE /api/v1/subscriptions/{id} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousNotificationChannels
NextAI Applications

Last updated