Admin - API Endpoints
privacyPolicyPrivacy PolicyBase 64 of PDF or url
https://www.helloiconic.com/privacy-policy0466770d-4024-457c-92d5-fbe9022ee5b7This icon should match with an existing icon in the frontend
book-openurlPossible values: 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
36000Public documents can be seen by anyone. Private documents can only be seen by logged in users. Default is false.
trueSuccessful Operation
{"statusCode":201}This error can occur because of an invalid value or because a value is required.
Failed because the authentication token is not sent or it has already expired.
The token is correct but you need a specific role to access this endpoint
An error occurred while entering the information
Failed because it already exists a document with this name in this category.
POST /admin/contents/documents HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 241
{
"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
}{
"statusCode": 201
}0466770d-4024-457c-92d5-fbe9022ee5b7termsAndConditionsTerms & ConditionsBase 64 of PDF or url
https://www.helloiconic.com/privacy-policy0466770d-4024-457c-92d5-fbe9022ee5b7This icon should match with an existing icon in the frontend
book-openThis is the order that will be returned to the frontend
5urlPossible values: 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
36000Public documents can be seen by anyone. Private documents can only be seen by logged in users. Default is false.
trueSuccessful Operation
{"statusCode":200}This error can occur because of an invalid value or because a value is required.
Failed because the authentication token is not sent or it has already expired.
The token is correct but you need a specific role to access this endpoint
An error occurred while entering the information
Failed because it already exists a document with this name in this category.
PUT /admin/contents/documents/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 260
{
"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
}{
"statusCode": 200
}0466770d-4024-457c-92d5-fbe9022ee5b7Successful Operation
{"statusCode":200}This error can occur because of an invalid value or because a value is required.
Failed because the authentication token is not sent or it has already expired.
The token is correct but you need a specific role to access this endpoint
An error occurred while entering the information
DELETE /admin/contents/documents/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}settingsSuccessful Operation
{"statusCode":201}This error can occur because of an invalid value or because a value is required.
Failed because the authentication token is not sent or it has already expired.
The token is correct but you need a specific role to access this endpoint
An error occurred while entering the information
Failed because it already exists a document category with this name.
POST /admin/contents/document-categories HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"name": "settings"
}{
"statusCode": 201
}0466770d-4024-457c-92d5-fbe9022ee5b7settingsSuccessful Operation
{"statusCode":200}This error can occur because of an invalid value or because a value is required.
Failed because the authentication token is not sent or it has already expired.
The token is correct but you need a specific role to access this endpoint
An error occurred while entering the information
Failed because it already exists a document category with this name.
PUT /admin/contents/document-categories/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"name": "settings"
}{
"statusCode": 200
}0466770d-4024-457c-92d5-fbe9022ee5b7Successful Operation
{"statusCode":200}This error can occur because of an invalid value or because a value is required.
Failed because the authentication token is not sent or it has already expired.
The token is correct but you need a specific role to access this endpoint
An error occurred while entering the information
DELETE /admin/contents/document-categories/{id} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}Last updated
Was this helpful?