Subscriptions

Use to manage notifications subscriptions.

Get user subscriptions

get

Get user subscriptions

Authorizations

AuthorizationstringRequired

Bearer authentication

Responses

200

User subscriptions

application/json

channelsstring[] · max: 100Required

idstring · max: 100Optional

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

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[] · max: 100Required

idstring · max: 100Optional

Responses

200

Subscription created successfully

application/json

channelsstring[] · max: 100Required

idstring · max: 100Optional

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

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

idstring · min: 1 · max: 100Required

Subscription id

Body

channelsstring[] · max: 100Required

Responses

200

Subscription created successfully

application/json

channelsstring[] · max: 100Required

idstring · max: 100Optional

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

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

idstring · min: 1 · max: 100Required

Subscription id

Responses

204

Subscription deleted successfully

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

501

unexpected error

application/json

503

unexpected error

application/json

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