Admin - API Endpoints | Linker Studio

🔗

Linker Studio

delete

Authorizations

Path parameters

idstringrequiredExample: 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

delete

Authorizations

Path parameters

idstringrequiredExample: 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

post

Authorizations

Body

namestringrequiredExample: privacyPolicy

titlestringrequiredExample: Privacy Policy

contentstringrequired

Base 64 of PDF or url

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

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

iconNamestringrequired

This icon should match with an existing icon in the frontend

Example: book-open

formatstring · enumrequiredExample: urlAvailable options:

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

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",
    "format": "url",
    "expirationTime": 36000,
    "isPublic": true
  }'

201

400

401

403

404

409

{
  "statusCode": 201
}

Successful Operation

put

Authorizations

Path parameters

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

Body

namestringoptionalExample: termsAndConditions

titlestringoptionalExample: Terms & Conditions

contentstringoptional

Base 64 of PDF or url

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

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

iconNamestringoptional

This icon should match with an existing icon in the frontend

Example: book-open

indexnumberoptional

This is the order that will be returned to the frontend

Example: 5

formatstring · enumoptionalExample: urlAvailable options:

expirationTimenumberoptional

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

isPublicbooleanoptional

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

Example: true

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,
    "format": "url",
    "expirationTime": 36000,
    "isPublic": true
  }'

200

400

401

403

404

409

{
  "statusCode": 200
}

Successful Operation

post

Authorizations

Body

namestringrequiredExample: 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

Authorizations

Path parameters

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

Body

namestringrequiredExample: 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