Sign in
request

Create new request

Changed on

Creates a new request with the provided media ID and type. The REQUEST permission is required.

If the user has the ADMIN or AUTO_APPROVE permissions, their request will be auomatically approved.

post/request

Request

  • Base URL: http://localhost:5055/api/v1
  • URL: http://localhost:5055/api/v1/request
  • Auth: one of:
    • API key in cookie connect.sid
    • API key in header X-Api-Key

Request body

mediaType'movie' | 'tv' required
mediaIdnumber required
tvdbIdnumber
is4kboolean
serverIdnumber
profileIdnumber
rootFolderstring
languageProfileIdnumber
userIdnumber nullable
ignoreQuotaboolean

If true, this request will not count against the user's quota. Requires MANAGE_REQUESTS permission.

Example request

{
  "mediaType": "movie",
  "mediaId": 123,
  "tvdbId": 123
}

Response

Succesfully created the request

idnumber required
statusnumber required

Status of the request. 1 = PENDING APPROVAL, 2 = APPROVED, 3 = DECLINED

createdAtstring
updatedAtstring
is4kboolean
serverIdnumber
profileIdnumber
rootFolderstring
ignoreQuotaboolean

If true, this request will not count against the user's quota. Requires MANAGE_REQUESTS permission.

Example response

{
  "id": 123,
  "media": {
    "createdAt": "2020-09-12T10:00:27.000Z",
    "updatedAt": "2020-09-12T10:00:27.000Z"
  },
  "createdAt": "2020-09-12T10:00:27.000Z",
  "updatedAt": "2020-09-12T10:00:27.000Z",
  "requestedBy": {
    "id": 1,
    "email": "hey@itsme.com",
    "userType": 1,
    "createdAt": "2020-09-02T05:02:23.000Z",
    "updatedAt": "2020-09-02T05:02:23.000Z",
    "requestCount": 5
  },
  "modifiedBy": {
    "id": 1,
    "email": "hey@itsme.com",
    "userType": 1,
    "createdAt": "2020-09-02T05:02:23.000Z",
    "updatedAt": "2020-09-02T05:02:23.000Z",
    "requestCount": 5
  }
}

Changes

  • aff087ba6b78Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status