Marketing plan API
List of plan items
The method returns a list of sections, items, and notes.
Request format
Request parameters
| Name | Required | Description |
| site_id | Yes | Site ID |
Result
If successful, the server returns a list of sections, items, and notes.
Response example
[
{
“title”: “Step 1. Semantic core and keyword research”,
“items”: [
{
“id”: “analyze_competitors”,
“title”: “Analyze competitors’ keywords”,
“checked”: true
},
{
“id”: “makeup_final_list”,
“title”: “Collect core keywords”,
“checked”: true
},
…
],
“id”: “keywords_research”,
“items_count”: 3,
“items_checked”: 3
},
…
]
Response parameters
| Name | Description |
| id | Section ID |
| title | Section name |
| items_count | Total number of items in a section
|
| items_checked | Total number of completed items
|
| items | Section items |
Section items
| Name | Description |
| id | Item ID |
| title | Item name |
| checked | Item status |
Adding tasks
Request format
POST /checklist/{site_id}/task
{
“title”: “text”,
“text”: “text description”,
“for_all” : false
}
Request parameters
| Name | Required | Description |
| title | Yes | Name |
| text | Yes | Description |
| for_all | No | For all projects |
Result
If successful, the server returns the ID of the created task.
Response example
Errors
| HTTP code | Error message |
| 400 | Empty title |
| 400 | Empty text |
Changing a task
Request format
PUT /checklist/{site_id}/task/
{
“task_id” : “makeup_final_list”,
“title”: “text”,
“text”: “text description”,
}
Request parameters
| Name | Required | Description |
| task_id | Yes | Task ID |
| title | Yes | Name |
| text | Yes | Description |
Result
If successful, the server returns the 200 HTTP code.
Errors
| HTTP code | Error message |
| 400 | Empty title |
| 400 | Empty text |
Deleting a task
Only tasks created via the method (POST /checklist/{site_id}/task) can be deleted.
Request format
DELETE /checklist/{site_id}/task/{task_id}
Result
If successful, the server returns the 204 HTTP code.
Setting a task’s status
Request format
PUT /checklist/{site_id}/task/
{
“task_id” : “makeup_final_list”,
“checked”: true
}
Request parameters
| Name | Required | Description |
| task_id | Yes | Task ID |
| checked | Yes | true-completed |
Result
If successful, the server returns the 200 HTTP code.
