Admin - API Endpoints

Only admins and super admins can use these endpoints.

POST/admin/contents/documents

Authorization

bearer

Body

application/json

name*string

Example: "privacyPolicy"

title*string

Example: "Privacy Policy"

content*string

Base 64 of PDF or url

Example: "https://www.helloiconic.com/privacy-policy"

documentCategoryId*string

Example: "0466770d-4024-457c-92d5-fbe9022ee5b7"

iconName*string

This icon should match with an existing icon in the frontend

Example: "book-open"

format*enum

Example: "url"

urlpdf

expirationTime*number

This value is in ms. This value is the expiration time of the presigned url. Default is 23 hours for PDFs, and is null for URLs and public documents

Example: 36000

isPublic*boolean

Public documents can be seen by anyone. Private documents can only be seen by logged in users. Default is false.

Example: true

Response

201400401403404409

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/contents/documents', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "privacyPolicy",
      "title": "Privacy Policy",
      "content": "https://www.helloiconic.com/privacy-policy",
      "documentCategoryId": "0466770d-4024-457c-92d5-fbe9022ee5b7",
      "iconName": "book-open",
      "format": "url",
      "expirationTime": 36000,
      "isPublic": true
    }),
});
const data = await response.json();

Response

201400401403404409

{
  "statusCode": 201
}

PUT/admin/contents/documents/{id}

Authorization

bearer

Path parameters

id*string

Example: "0466770d-4024-457c-92d5-fbe9022ee5b7"

Body

application/json

namestring

Example: "termsAndConditions"

titlestring

Example: "Terms & Conditions"

contentstring

Base 64 of PDF or url

Example: "https://www.helloiconic.com/privacy-policy"

documentCategoryIdstring

Example: "0466770d-4024-457c-92d5-fbe9022ee5b7"

iconNamestring

This icon should match with an existing icon in the frontend

Example: "book-open"

indexnumber

This is the order that will be returned to the frontend

Example: 5

formatenum

Example: "url"

urlpdf

expirationTimenumber

This value is in ms. This value is the expiration time of the presigned url. Default is 23 hours for PDFs, and is null for URLs and public documents

Example: 36000

isPublicboolean

Public documents can be seen by anyone. Private documents can only be seen by logged in users. Default is false.

Example: true

Response

200400401403404409

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/contents/documents/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404409

{
  "statusCode": 200
}

DELETE/admin/contents/documents/{id}

Authorization

bearer

Path parameters

id*string

Example: "0466770d-4024-457c-92d5-fbe9022ee5b7"

Response

200400401403404

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/contents/documents/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401403404

{
  "statusCode": 200
}

POST/admin/contents/document-categories

Authorization

bearer

Body

application/json

name*string

Example: "settings"

Response

201400401403404409

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/contents/document-categories', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "settings"
    }),
});
const data = await response.json();

Response

201400401403404409

{
  "statusCode": 201
}

PUT/admin/contents/document-categories/{id}

Authorization

bearer

Path parameters

id*string

Example: "0466770d-4024-457c-92d5-fbe9022ee5b7"

Body

application/json

name*string

Example: "settings"

Response

200400401403404409

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/contents/document-categories/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "settings"
    }),
});
const data = await response.json();

Response

200400401403404409

{
  "statusCode": 200
}

DELETE/admin/contents/document-categories/{id}

Authorization

bearer

Path parameters

id*string

Example: "0466770d-4024-457c-92d5-fbe9022ee5b7"

Response

200400401403404

Successful Operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/admin/contents/document-categories/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401403404

{
  "statusCode": 200
}