MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

Base URL

Endpoints

User's

User Login

Example request:
curl --request POST \
            "{'base url'}/api/v1/userlogin" \
            --header "Content-Type: application/json" \
            --header "Accept: application/json" \
            --data "{
            \"email\": \"corrupti\",
            \"password\": \"assumenda\"
        }"
        
const url = new URL(
            "{'base url'}/api/v1/userlogin"
        );
        
        const headers = {
            "Content-Type": "application/json",
            "Accept": "application/json",
        };
        
        let body = {
            "email": "corrupti",
            "password": "assumenda"
        };
        
        fetch(url, {
            method: "POST",
            headers,
            body: JSON.stringify(body),
        }).then(response => response.json());

POST api/v1/userlogin

Body Parameters

email  string  

password  string  

Update Profile

Example request:
curl --request POST \
            "{'base url'}/api/v1/updateprofile" \
            --header "Content-Type: application/json" \
            --header "Accept: application/json" \
            --header "token: Your API token here" \
            --header "apikey: Your API key here" \
            --header "apisecretkey: Your API Secret key here" \
            --data "{
            \"firstName\": \"ad\",
            \"lastName\": \"nihil\"
        }"
        
const url = new URL(
            "{'base url'}/api/v1/updateprofile"
        );
        
        const headers = {
            "Content-Type": "application/json",
            "Accept": "application/json",
            "token": "Your API token here",
            "apikey": "Your API key here",
            "apisecretkey": "Your API Secret key here",
        };
        
        let body = {
            "firstName": "ad",
            "lastName": "nihil"
        };
        
        fetch(url, {
            method: "POST",
            headers,
            body: JSON.stringify(body),
        }).then(response => response.json());

POST api/v1/updateprofile

Body Parameters

firstName  string  

lastName  string  

List Posts

Example request:
curl --request POST \
            "{'base url'}/api/v1/listposts" \
            --header "Content-Type: application/json" \
            --header "Accept: application/json" \
            --header "token: Your API token here" \
            --header "apikey: Your API key here" \
            --header "apisecretkey: Your API Secret key here" \
            --data "{
           \"accountId\": \513\"
        }"
        
const url = new URL(
            "{'base url'}/api/v1/listposts"
        );
        
        const headers = {
            "Content-Type": "application/json",
            "Accept": "application/json",
            "token": "Your API token here",
            "apikey": "Your API key here",
            "apisecretkey": "Your API Secret key here",
        };
        
        let body = {
            "accountId": "513"
            
        };
        
        fetch(url, {
            method: "POST",
            headers,
            body: JSON.stringify(body),
        }).then(response => response.json());

POST api/v1/listposts

Body Parameters

accountId  integer  

Post

Add Post

Example request:
curl --request POST \
    "{'base url'}/api/v1/addpost" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"postImage\": \"a\",
    \"postTitle\": \"nesciunt\",
    \"postSlug\": \"consequuntur\",
    \"postAuthorId\": 9,
    \"postStatus\": \"autem\",
    \"postPublishAt\": \"2022-07-28T05:20:50\",
    \"postButtonText\": \"labore\",
    \"postSeoPrimaryKeyword\": \"praesentium\",
    \"postSeoOtherKeyword\": \"possimus\",
    \"postSeoPostTitle\": \"quia\",
    \"postSeoMetaDescription\": \"voluptatum\",
    \"postCanonicalUrl\": \"http:\\/\\/www.morissette.com\\/doloremque-a-cum-laborum-magnam-doloribus-unde-et\",
    \"postEnableCommenting\": \"Yes or No\",
    \"postEnableSharing\": \"Yes or No\",
    \"postHidePostFromBlog\": \"Yes or No\",
    \"accountId\": 0,
    \"postId\": 1
    \"accountId\": 0
}"
const url = new URL(
    "{'base url'}/api/v1/addpost"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "postImage": "a",
    "postTitle": "nesciunt",
    "postSlug": "consequuntur",
    "postAuthorId": 9,
    "postStatus": "autem",
    "postPublishAt": "2022-07-28T05:20:50",
    "postButtonText": "labore",
    "postSeoPrimaryKeyword": "praesentium",
    "postSeoOtherKeyword": "possimus",
    "postSeoPostTitle": "quia",
    "postSeoMetaDescription": "voluptatum",
    "postCanonicalUrl": "http:\\/\\/www.morissette.com\\/doloremque-a-cum-laborum-magnam-doloribus-unde-et",
    "postEnableCommenting": "Yes or No",
    "postEnableSharing": "Yes or No",
    "postHidePostFromBlog": "Yes or No",
    "accountId": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/addpost

Body Parameters

postImage  string optional  

postTitle  string  

postSlug  string optional  

postContent  string optional  

postAuthorId  integer optional  

postCategoriesId  integer optional  

postRelatedPostId  integer optional  

postStatus  string optional  

postPublishAt  date optional  

Must be a valid date.

postButtonText  string optional  

postSeoPrimaryKeyword  string optional  

postSeoOtherKeyword  string optional  

postSeoPostTitle  string optional  

postSeoMetaDescription  string optional  

postCanonicalUrl  url optional  

Must be a valid URL.

postEnableCommenting  string optional  

postEnableSharing  string optional  

postHidePostFromBlog  string optional  

accountId  integer  

Must be at least 1.

Update Post

Example request:
curl --request POST \
    "{'base url'}/api/v1/updatepost" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"postImage\": \"maiores\",
    \"postTitle\": \"id\",
    \"postSlug\": \"eius\",
    \"postAuthorId\": 16,
    \"postStatus\": \"ullam\",
    \"postPublishAt\": \"2022-07-28T05:20:50\",
    \"postButtonText\": \"ut\",
    \"postSeoPrimaryKeyword\": \"quas\",
    \"postSeoOtherKeyword\": \"tempore\",
    \"postSeoPostTitle\": \"expedita\",
    \"postSeoMetaDescription\": \"error\",
    \"postCanonicalUrl\": \"http:\\/\\/www.morissette.com\\/doloremque-a-cum-laborum-magnam-doloribus-unde-et\",
    \"postEnableCommenting\": \"Yes or No\",
    \"postEnableSharing\": \"Yes or No\",
    \"postHidePostFromBlog\": \"Yes or No\",
    \"accountId\": 0,
    \"postId\": 1
}"
const url = new URL(
    "{'base url'}/api/v1/updatepost"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "postImage": "maiores",
    "postTitle": "id",
    "postSlug": "eius",
    "postAuthorId": 16,
    "postStatus": "ullam",
    "postPublishAt": "2022-07-28T05:20:50",
    "postButtonText": "ut",
    "postSeoPrimaryKeyword": "quas",
    "postSeoOtherKeyword": "tempore",
    "postSeoPostTitle": "expedita",
    "postSeoMetaDescription": "error",
    "postCanonicalUrl": "http:\/\/www.morissette.com\/doloremque-a-cum-laborum-magnam-doloribus-unde-et",
    "postEnableCommenting": "Yes or No",
    "postEnableSharing": "Yes or No",
    "postHidePostFromBlog": "Yes or No",
    "accountId": 0,
    "postId": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/updatepost

Body Parameters

postImage  string optional  

postTitle  string  

postSlug  string optional  

postContent  string optional  

postAuthorId  integer optional  

postCategoriesId  integer optional  

postRelatedPostId  integer optional  

postStatus  string optional  

postPublishAt  date optional  

Must be a valid date.

postButtonText  string optional  

postSeoPrimaryKeyword  string optional  

postSeoOtherKeyword  string optional  

postSeoPostTitle  string optional  

postSeoMetaDescription  string optional  

postCanonicalUrl  url optional  

Must be a valid URL.

postEnableCommenting  string optional  

postEnableSharing  string optional  

postHidePostFromBlog  string optional  

accountId  integer  

Must be at least 1.

postId  integer  

Delete Post

Example request:
curl --request POST \
    "{'base url'}/api/v1/deletepost" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"postId\": 0,
    \"accountId\": 1
}"
const url = new URL(
    "{'base url'}/api/v1/deletepost"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "postId": 0,
    "accountId": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/deletepost

Body Parameters

postId  integer  

Must be at least 1.

accountId  integer  

Must be at least 1.

Post Embed Code

Example request:
curl --request POST \
            "{base url}/api/v1/postembedcode" \
            --header "Content-Type: application/json" \
            --header "Accept: application/json" \
            --header "token: Your API token here" \
            --header "apikey: Your API key here" \
            --header "apisecretkey: Your API Secret key here" \
            --data "{
            \"accountId\": 0
        }"
        
const url = new URL(
            "{'base url'}/api/v1/postembedcode"
        );
        
        const headers = {
            "Content-Type": "application/json",
            "Accept": "application/json",
            "token": "Your API token here",
            "apikey": "Your API key here",
            "apisecretkey": "Your API Secret key here",
        };
        
        let body = {
            "accountId": 0
        };
        
        fetch(url, {
            method: "POST",
            headers,
            body: JSON.stringify(body),
        }).then(response => response.json());

POST api/v1/postembedcode

Body Parameters

accountId  integer  

Must be at least 1.

Category

List Categories

Example request:
curl --request POST \
    "{'base url'}/api/v1/listcategories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"accountId\": 1
}"
const url = new URL(
    "{'base url'}/api/v1/listcategories"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "accountId": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/listcategories

Body Parameters

accountId  integer  

Must be at least 1.

Add Category

Example request:
curl --request POST \
    "{'base url'}/api/v1/addcategory" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"catName\": \"consectetur\",
    \"catLabelColor\": \"omnis\",
    \"catLabelFontSize\": 16,
    \"catLabelTextColor\": \"officiis\",
    \"subAccountId\": 17
}"
const url = new URL(
    "{'base url'}/api/v1/addcategory"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "catName": "consectetur",
    "catLabelColor": "omnis",
    "catLabelFontSize": 16,
    "catLabelTextColor": "officiis",
    "subAccountId": 17
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/addcategory

Body Parameters

catName  string optional  

catLabelColor  string optional  

catLabelFontSize  integer optional  

catLabelTextColor  string optional  

subAccountId  integer optional (If this param is empty then category will be added to parent account)  

Update Category

Example request:
curl --request POST \
    "{'base url'}/api/v1/updatecategory" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"catName\": \"et\",
    \"catLabelColor\": \"laborum\",
    \"catLabelFontSize\": \"et\",
    \"catLabelTextColor\": \"adipisci\",
    \"catId\": 1
}"
const url = new URL(
    "{'base url'}/api/v1/updatecategory"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "catName": "et",
    "catLabelColor": "laborum",
    "catLabelFontSize": "et",
    "catLabelTextColor": "adipisci",
    "catId": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/updatecategory

Body Parameters

catName  string optional  

catLabelColor  string optional  

catLabelFontSize  integer optional  

catLabelTextColor  string optional  

catId  integer  

Must be at least 1.

Delete Category

Example request:
curl --request POST \
    "{'base url'}/api/v1/deletecategory" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"catId\": 1
}"
const url = new URL(
    "{'base url'}/api/v1/deletecategory"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "catId": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/deletecategory

Body Parameters

catId  integer  

Must be at least 1.

List Teams

Example request:
curl --request POST \
            "{'base url'}/api/v1/listteams" \
            --header "Content-Type: application/json" \
            --header "Accept: application/json" \
            --header "token: Your API token here" \
            --header "apikey: Your API key here" \
            --header "apisecretkey: Your API Secret key here" \
            --data "{
            \"accountId\": \513\"
        }"
        
const url = new URL(
            "{'base url'}/api/v1/listteams"
        );
        
        const headers = {
            "Content-Type": "application/json",
            "Accept": "application/json",
            "token": "Your API token here",
            "apikey": "Your API key here",
            "apisecretkey": "Your API Secret key here",
        };
        
        let body = {
            "accountId": "513"
        };
        
        fetch(url, {
            method: "POST",
            headers,
            body: JSON.stringify(body),
        }).then(response => response.json());

POST api/v1/listteams

Body Parameters

accountId  integer  

Team

Create Team

Example request:
curl --request POST \
    "{'base url'}/api/v1/createteam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"teamName\": \"enim\",
    \"assignAccountId\": \"quas\"
}"
const url = new URL(
    "{'base url'}/api/v1/createteam"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "teamName": "enim",
    "assignAccountId": "quas"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/createteam

Body Parameters

teamName  string  

assignAccountId  integer  

Update Team

Example request:
curl --request POST \
    "{'base url'}/api/v1/updateteam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"teamName\": \"id\",
    \"assignAccountId\": \"error\",
    \"teamId\": 3
}"
const url = new URL(
    "{'base url'}/api/v1/updateteam"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "teamName": "id",
    "assignAccountId": "error",
    "teamId": 3
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/updateteam

Body Parameters

teamName  string  

assignAccountId  integer  

teamId  integer  

Delete Team

Example request:
curl --request POST \
    "{'base url'}/api/v1/deleteteam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"teamId\": 12
}"
const url = new URL(
    "{'base url'}/api/v1/deleteteam"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "teamId": 12
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/deleteteam

Body Parameters

teamId  integer  

User Team

List Users

Example request:
curl --request POST \
            "{'base url'}/api/v1/listusers" \
            --header "Content-Type: application/json" \
            --header "Accept: application/json" \
            --header "token: Your API token here" \
            --header "apikey: Your API key here" \
            --header "apisecretkey: Your API Secret key here" \
            --data "{
            \"accountId\": \513\"
        }"
        
const url = new URL(
            "{'base url'}/api/v1/listusers"
        );
        
        const headers = {
            "Content-Type": "application/json",
            "Accept": "application/json",
            "token": "Your API token here",
            "apikey": "Your API key here",
            "apisecretkey": "Your API Secret key here",
        };
        
        let body = {
            "accountId": "513"
        };
        
        fetch(url, {
            method: "POST",
            headers,
            body: JSON.stringify(body),
        }).then(response => response.json());

POST api/v1/listusers

Body Parameters

accountId  integer  

Add User To Team

Example request:
curl --request POST \
    "{'base url'}/api/v1/addusertoteam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"userEmail\": \"voluptatem\",
    \"userRoleName\": \"sed\",
    \"teamId\": 12
}"
const url = new URL(
    "{'base url'}/api/v1/addusertoteam"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "userEmail": "voluptatem",
    "userRoleName": "sed",
    "teamId": 12
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/addusertoteam

Body Parameters

userEmail  string  

userRoleName  string  

teamId  integer  

Update Team User Role

Example request:
curl --request POST \
    "{'base url'}/api/v1/updateteamuserrole" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"userEmail\": \"perspiciatis\",
    \"userRoleName\": \"facere\",
    \"teamId\": 9
}"
const url = new URL(
    "{'base url'}/api/v1/updateteamuserrole"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "userEmail": "perspiciatis",
    "userRoleName": "facere",
    "teamId": 9
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/updateteamuserrole

Body Parameters

userEmail  string  

userRoleName  string  

teamId  integer  

Delete Team User

Example request:
curl --request POST \
    "{'base url'}/api/v1/deleteteamuser" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"teamId\": 1,
    \"userEmail\": \"consequatur\"
}"
const url = new URL(
    "{'base url'}/api/v1/deleteteamuser"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "teamId": 1,
    "userEmail": "consequatur"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/deleteteamuser

Body Parameters

teamId  integer  

userEmail  string  

Author

List Authors

Example request:
curl --request POST \
    "{'base url'}/api/v1/listauthors" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"accountId\": 0
}"
const url = new URL(
    "{'base url'}/api/v1/listauthors"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "accountId": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/listauthors

Body Parameters

accountId  integer  

Must be at least 1.

Add Author

Example request:
curl --request POST \
    "{'base url'}/api/v1/addauthor" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"authorImg\": \"aperiam\",
    \"authorName\": \"consequatur\",
    \"authorBio\": \"est\",
    \"subAccountId\": 2
}"
const url = new URL(
    "{'base url'}/api/v1/addauthor"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "authorImg": "aperiam",
    "authorName": "consequatur",
    "authorBio": "est",
    "subAccountId": 2
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/addauthor

Body Parameters

authorImg  string optional  

authorName  string  

authorBio  string optional  

subAccountId  integer optional (If this param is empty then category will be added to parent account)  

Update Author

Example request:
curl --request POST \
    "{'base url'}/api/v1/updateauthor" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"authorImg\": \"autem\",
    \"authorName\": \"non\",
    \"authorBio\": \"explicabo\",
    \"subAccountId\": 12,
    \"authorId\": 16
}"
const url = new URL(
    "{'base url'}/api/v1/updateauthor"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "authorImg": "autem",
    "authorName": "non",
    "authorBio": "explicabo",
    "subAccountId": 12,
    "authorId": 16
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/updateauthor

Body Parameters

authorImg  string optional  

authorName  string  

authorBio  string optional  

subAccountId  integer  

authorId  integer  

Delete Author

Example request:
curl --request POST \
    "{'base url'}/api/v1/deleteauthor" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"authorId\": 1
}"
const url = new URL(
    "{'base url'}/api/v1/deleteauthor"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "authorId": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/deleteauthor

Body Parameters

authorId  integer  

Must be at least 1.

Sub-Account

Create Sub-Account

Example request:
curl --request POST \
    "{'base url'}/api/v1/createsubaccount" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"name\": \"fugiat\",
    \"parentAccountId\": 19
}"
const url = new URL(
    "{'base url'}/api/v1/createsubaccount"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "name": "fugiat",
    "parentAccountId": 19
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/createsubaccount

Body Parameters

name  string  

parentAccountId  integer  

List Sub-Accounts

Example request:
curl --request GET \
            --get "{'base url'}/api/v1/listsubaccounts" \
            --header "Content-Type: application/json" \
            --header "Accept: application/json" \
            --header "token: Your API token here" \
            --header "apikey: Your API key here" \
            --header "apisecretkey: Your API Secret key here"
const url = new URL(
            "{'base url'}/api/v1/listsubaccounts"
        );
        
        const headers = {
            "Content-Type": "application/json",
            "Accept": "application/json",
            "token": "Your API token here",
            "apikey": "Your API key here",
            "apisecretkey": "Your API Secret key here",
        };
        
        fetch(url, {
            method: "GET",
            headers,
        }).then(response => response.json());

GET api/v1/listsubaccounts

Update Sub-Account

Example request:
curl --request POST \
    "{'base url'}/api/v1/updatesubaccount" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"updatedSubAccountName\": \"recusandae\",
    \"subAccountId\": 0
}"
const url = new URL(
    "{'base url'}/api/v1/updatesubaccount"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "updatedSubAccountName": "recusandae",
    "subAccountId": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/updatesubaccount

Body Parameters

updatedSubAccountName  string  

subAccountId  integer  

Must be at least 1.

Delete Sub-Account

Example request:
curl --request POST \
    "{'base url'}/api/v1/deletesubaccount" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "token: Your API token here" \
    --header "apikey: Your API key here" \
    --header "apisecretkey: Your API Secret key here" \
    --data "{
    \"subAccountId\": 0
}"
const url = new URL(
    "{'base url'}/api/v1/deletesubaccount"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "token": "Your API token here",
    "apikey": "Your API key here",
    "apisecretkey": "Your API Secret key here",
};

let body = {
    "subAccountId": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

POST api/v1/deletesubaccount

Body Parameters

subAccountId  integer  

Must be at least 1.

Webhooks

Introduction

This documentation aims to provide all the information you need to work with our Webhooks.

Event Name

Event Slug

Description

Create post

post.create

This webhook will be triggered on adding a new post in Quickblog.

Update post

post.update

This webhook will be triggered on updating post in Quickblog.

Delete post

post.delete

This webhook will be triggered on delete post in Quickblog.

Create category

category.create

This webhook will be triggered on adding a new category in Quickblog.

Update category

category.update

This webhook will be triggered on updating category in Quickblog.

Delete category

category.delete

This webhook will be triggered on deleting category in Quickblog.

Create author

author.create

This webhook will be triggered on add author in Quickblo.

Update author

author.update

This webhook will be triggered on update author in Quickblog.

Delete author

author.delete

This webhook will be triggered on deleting author in Quickblog.

User invited

user.invited

This webhook will be triggered on inviting user in Quickblog.

Edit user invited

user.editinvite

This webhook will be triggered on edit invited user in Quickblog.

Accept user invite

user.acceptinvite

This webhook will be triggered on when user accept invite.

Decline user invite

user.declineinvite

This webhook will be triggered on declining the invitation.

Create team

team.create

This webhook will be triggered on creating new team in Quickblog.

Update team

team.update

This webhook will be triggered on update team in Quickblog.

Delete team

team.delete

This webhook will be triggered on deleting team in Quickblog.

Create sub-account

subaccount.create

This webhook will be triggered on add a new sub-account in Quickblog.

Update sub-account

subaccount.update

This webhook will be triggered on update sub-account in Quickblog.

Delete sub-account

subaccount.delete

This webhook will be triggered on deleting sub-account in Quickblog.

Endpoints

List Webhooks

Example request:
curl --request POST \
                                "{'base url'}/api/v1/webhooks/list" \
                                --header "Content-Type: application/json" \
                                --header "Accept: application/json" \
                                --header "token: Your API token here" \
                                --header "apikey: Your API key here" \
                                --header "apisecretkey: Your API Secret key here" \
                                --data "{
                                \"accountId\": 123
                            }"
                            
const url = new URL(
                                "{'base url'}/api/v1/webhooks/list"
                            );

                            const headers = {
                                "Content-Type": "application/json",
                                "Accept": "application/json",
                                "token": "Your API token here",
                                "apikey": "Your API key here",
                                "apisecretkey": "Your API Secret key here",
                            };

                            let body = {
                                "accountId": 123
                            };

                            fetch(url, {
                                method: "POST",
                                headers,
                                body: JSON.stringify(body),
                            }).then(response => response.json());

POST api/v1/webhooks/list

Body Parameters

accountId  integer  

Create Webhook

Example request:
 curl --request POST \
                                "{'base url'}/api/v1/webhooks/create" \
                                --header "Content-Type: application/json" \
                                --header "Accept: application/json" \
                                --header "token: Your API token here" \
                                --header "apikey: Your API key here" \
                                --header "apisecretkey: Your API Secret key here" \
                                --data "{
                                \"name\": test,
                                \"endpointUrl\": https://example.com,
                                \"event\": Create post (Defined in Webhook introduction as Event Name),
                                \"status\": enable or disable ,
								\"accountId\": 123
								
                            }"
                            
                                                    
                                                        const url = new URL(
                                "{'base url'}/api/v1/webhooks/create"
                            );

                            const headers = {
                                "Content-Type": "application/json",
                                "Accept": "application/json",
                                "token": "Your API token here",
                                "apikey": "Your API key here",
                                "apisecretkey": "Your API Secret key here",
                            };

                            let body = {
                                "name": test,
                                "endpointUrl":https://example.com,
                                "event":"Create post"(Defined in Webhook introduction as Event Name),
                                "status":enable or disable,
								"accouhntId": 123
                            };

                            fetch(url, {
                                method: "POST",
                                headers,
                                body: JSON.stringify(body),
                            }).then(response => response.json());

POST api/v1/webhooks/create

Body Parameters

name  string  

endpointUrl  string  

event  string   (Defined in Webhooks introduction as Event Name)  

status  string  

accountId  integer  

Update Webhook

Example request:
                                curl --request POST \
                                "{'base url'}/api/v1/webhooks/edit" \
                                --header "Content-Type: application/json" \
                                --header "Accept: application/json" \
                                --header "token: Your API token here" \
                                --header "apikey: Your API key here" \
                                --header "apisecretkey: Your API Secret key here" \
                                --data "{
                                \"webhookId\": 121, 
                                \"name\": test,
                                \"endpointUrl\": https://example.com,
                                \"event\": Create post (Defined in Webhook introduction as Event Name),
                                \"status\": enable or disable,
								\"accountId\": 123}
								"
                            
const url = new URL(
                                "{'base url'}/api/v1/webhooks/edit"
                            );

                            const headers = {
                                "Content-Type": "application/json",
                                "Accept": "application/json",
                                "token": "Your API token here",
                                "apikey": "Your API key here",
                                "apisecretkey": "Your API Secret key here",
                            };

                            let body = {
                                "webhookId":123
                                "name": test,
                                "endpointUrl":https://example.com,
                                "event":"Create post"(Defined in Webhook introduction as Event Name),
                                "status":enable or disable,
								"accountId": 123
                            };

                            fetch(url, {
                                method: "POST",
                                headers,
                                body: JSON.stringify(body),
                            }).then(response => response.json());

POST api/v1/webhooks/edit

Body Parameters

webhookId  integer  

name  string  

endpointUrl  string  

event  string   (Defined in Webhooks introduction as Event Name)  

status  string  

accountId  integer  

Delete Webhook

Example request:
                                curl --request POST \
"{'base url'}/api/v1/webhooks/delete" \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "token: Your API token here" \ --header "apikey: Your API key here" \ --header "apisecretkey: Your API Secret key here" \ --data "{ \"webhookId\": 121, \"accountId"\: 321 }"
const url = new URL(
                                "{'base url'}/api/v1/webhooks/delete"
                            );

                            const headers = {
                                "Content-Type": "application/json",
                                "Accept": "application/json",
                                "token": "Your API token here",
                                "apikey": "Your API key here",
                                "apisecretkey": "Your API Secret key here",
                            };

                            let body = {
                                "webhookId":123,
								"accountId": 321
								
                               
                            };

                            fetch(url, {
                                method: "POST",
                                headers,
                                body: JSON.stringify(body),
                            }).then(response => response.json());

POST api/v1/webhooks/delete

Body Parameters

webhookId  integer  

acccountId  integer  

Post Webhook

Add-Post Webhook (This webhook will be triggered on adding a new post in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

postTitle  string  

postContent  string  

articleId  integer  

blogLink  url  

author  string  

categories  string 

status  string  

seoScore  integer  

keyword  string  

seoPostTitle  string  

seoMetaDescription  string  

datetime  date  

Update-Post Webhook (This webhook will be triggered on updating post in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

postTitle  string  

postContent  string  

articleId  integer  

blogLink  url  

author  string  

categories  string 

status  string  

seoScore  integer  

keyword  string  

seoPostTitle  string  

seoMetaDescription  string  

datetime  date  

Delete-Post Webhook (This webhook will be triggered on delete post in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

postTitle  string  

postContent  string  

articleId  integer  

blogLink  url  

Category Webhook

Add-category Webhook (This webhook will be triggered on adding a new category in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

categoryId  integer  

categoryName  string  

categorySlug  string  

categoryDateTime  date  

Update-Category Webhook (This webhook will be triggered on updating category in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

categoryId  integer  

categoryName  string  

categorySlug  string  

categoryDateTime  date  

Delete-Category Webhook (This webhook will be triggered on deleting category in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

categoryId  integer  

categoryName  string  

categorySlug  string  

categoryDateTime  date  

Author Webhook

Add-Author Webhook (This webhook will be triggered on add author in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

authorId  integer  

authorName  string  

authorUrlSlug  string  

authorDateTime  date  

Update-Author Webhook (This webhook will be triggered on update author in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

authorId  integer  

authorName  string  

authorUrlSlug  string  

authorDateTime  date  

Delete-Author Webhook (This webhook will be triggered on deleting author in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

authorId  integer  

authorName  string  

authorUrlSlug  string  

authorDateTime  date  

User's Webhook

User Invited Webhook (This webhook will be triggered on inviting user in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

userEmail  string  

memberId  integer  

name  string  

role  string  

author  string  

teamName  string 

teamId  integer  

dateTime  date  

Edit Invited User Webhook (This webhook will be triggered on edit invited user in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

userEmail  string  

memberId  integer  

name  string  

role  string  

author  string  

teamName  string 

teamId  integer  

dateTime  date  

Accepted Invited User Webhook (This webhook will be triggered on when user accept invite)

Method Type  POST

Incoming Parameters from Webhook

userEmail  string  

memberId  integer  

name  string  

role  string  

author  string  

teamName  string 

teamId  integer  

dateTime  date  

Declined Invited User Webhook (This webhook will be triggered on declining the invitation)

Method Type  POST

Incoming Parameters from Webhook

userEmail  string  

memberId  integer  

name  string  

role  string  

author  string  

teamName  string 

teamId  integer  

dateTime  date  

Team Webhook

Create-Team Webhook (This webhook will be triggered on creating new team in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

teamName  string  

teamId  integer  

subAccountAccessNames  string  

subAccountAccessIds  integer  

dateTime  date  

Update-Team Webhook (This webhook will be triggered on update team in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

teamName  string  

teamId  integer  

subAccountAccessNames  string  

subAccountAccessIds  integer  

dateTime  date  

Delete-Team Webhook (This webhook will be triggered on deleting team in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

teamName  string  

teamId  integer  

subAccountAccessNames  string  

subAccountAccessIds  integer  

dateTime  date  

Sub-Account Webhook

Create Sub-Account Webhook (This webhook will be triggered on add a new sub-account in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

accountMasterEmail  string  

subAccountName  string  

subAccounId  integer  

dateTime  date  

Update Sub-Account Webhook (This webhook will be triggered on update sub-account in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

accountMasterEmail  string  

subAccountName  string  

subAccounId  integer  

dateTime  date  

Delete Sub-Account Webhook (This webhook will be triggered on deleting sub-account in Quickblog)

Method Type  POST

Incoming Parameters from Webhook

accountMasterEmail  string  

subAccountName  string  

subAccounId  integer  

dateTime  date