Admin - API Endpoints

Only admins and super admins can use these endpoints.

PreviousClient - API Endpoints NextApp Versions

Last updated 2 years ago

Was this helpful?

post

/admin/contents/documents

Authorizations

Body

namestringrequired

Example: privacyPolicy

titlestringrequired

Example: Privacy Policy

contentstringrequired

Base 64 of PDF or url

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

documentCategoryIdstringrequired

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

iconNamestringrequired

This icon should match with an existing icon in the frontend

Example: book-open

expirationTimenumberrequired

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

isPublicbooleanrequired

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

Example: true

formatstring · enumrequired

Example: url

Options: url, pdf

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/admin/contents/documents' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"privacyPolicy","title":"Privacy Policy","content":"https://www.helloiconic.com/privacy-policy","documentCategoryId":"0466770d-4024-457c-92d5-fbe9022ee5b7","iconName":"book-open","expirationTime":36000,"isPublic":true,"format":"url"}'

201

400

401

403

404

409

{
  "statusCode": 201
}

Successful Operation

put

/admin/contents/documents/{id}

Authorizations

Path parameters

idstringrequired

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

Body

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

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

formatstring · enum

Example: url

Options: url, pdf

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/admin/contents/documents/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"termsAndConditions","title":"Terms & Conditions","content":"https://www.helloiconic.com/privacy-policy","documentCategoryId":"0466770d-4024-457c-92d5-fbe9022ee5b7","iconName":"book-open","index":5,"expirationTime":36000,"isPublic":true,"format":"url"}'

200

400

401

403

404

409

{
  "statusCode": 200
}

Successful Operation

delete

/admin/contents/documents/{id}

Authorizations

Path parameters

idstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/admin/contents/documents/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

{
  "statusCode": 200
}

Successful Operation

post

/admin/contents/document-categories

Authorizations

Body

namestringrequired

Example: settings

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/admin/contents/document-categories' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"settings"}'

201

400

401

403

404

409

{
  "statusCode": 201
}

Successful Operation

put

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

Authorizations

Path parameters

idstringrequired

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

Body

namestringrequired

Example: settings

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/admin/contents/document-categories/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"settings"}'

200

400

401

403

404

409

{
  "statusCode": 200
}

Successful Operation

delete

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

Authorizations

Path parameters

idstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/admin/contents/document-categories/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

{
  "statusCode": 200
}

Successful Operation