Marketing Plan
Marketing Plan API provides endpoints to retrieve and manage marketing plan checklists for a site. These endpoints allow you to view marketing plan sections and tasks, create custom tasks, update task details, delete tasks, and change task completion status.
List plan items
GET https://api.seranking.com/v1/project-management/marketing-plan
Returns a list of marketing plan sections, items, and notes.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| site_id | Integer | Yes | Unique site ID (path parameter). |
Request example
GET https://api.seranking.com/v1/project-management/marketing-plan?site_id=123Response parameters
If successful, the server returns the 200 HTTP status code and an array of marketing plan sections.
| Parameter | Type | Description |
|---|---|---|
| id | String | Unique section ID. |
| title | String | Section name. |
| items_count | Integer | Number of items in the section. |
| items_checked | Integer | Number of completed items in the section. |
| items | Array | List of items in the section. |
The item object has the following structure:
| Parameter | Type | Description |
|---|---|---|
| id | String | Unique item ID. |
| title | String | Item name. |
| checked | Boolean | Item completion status. |
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
},
...
]Add task
POST https://api.seranking.com/v1/project-management/marketing-plan/tasks
Creates a new custom task in the marketing plan.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| site_id | Integer | Yes | Unique site ID (path parameter). |
| title | String | Yes | Task name. |
| text | String | Yes | Task description. |
| for_all | Boolean | No | Indicates whether the task applies to all projects. |
Request example
POST https://api.seranking.com/v1/project-management/marketing-plan/tasks?site_id=123
{
"title": "Create landing page",
"text": "Prepare and publish a new landing page for the campaign",
"for_all": false
}
Response parameters
If successful, the server returns the 200 HTTP status code and an object containing the created task ID. Returns HTTP 400 if the title or text is empty (for more information, see Error handling).
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Unique ID of the created task. |
Response example
{"id": 1}Update task
PATCH https://api.seranking.com/v1/project-management/marketing-plan/tasks
Updates the name and description of an existing task.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| site_id | Integer | Yes | Unique site ID (path parameter). |
| task_id | String | Yes | Unique task ID. |
| title | String | Yes | Task name. |
| text | String | Yes | Task description. |
Request example
PATCH https://api.seranking.com/v1/project-management/marketing-plan/tasks?site_id=123
{
"task_id": "makeup_final_list",
"title": "Update keyword list",
"text": "Add new high-priority keywords"
}Response parameters
If successful, the server returns the 200 HTTP status code. Returns HTTP 400 if the title or text is empty (for more information, see Error handling).
Response example
No response body.
Delete task
DELETE https://api.seranking.com/v1/project-management/marketing-plan/tasks
Deletes a custom task from the marketing plan. Only tasks created using the Add task endpoint can be deleted.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| site_id | Integer | Yes | Unique site ID (path parameter). |
| task_id | Integer | Yes | Unique task ID (path parameter). |
Request example
DELETE https://api.seranking.com/v1/project-management/marketing-plan/tasks?site_id=123&task_id=123Response parameters
If successful, the server returns the 204 HTTP status code.
Response example
No response body.
Set task status
PATCH https://api.seranking.com/v1/project-management/marketing-plan/tasks
Updates the completion status of a task.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| site_id | Integer | Yes | Unique site ID (path parameter). |
| task_id | String | Yes | Unique task ID. |
| checked | Boolean | Yes | Task completion status. |
Request example
PUT https://api.seranking.com/v1/project-management/marketing-plan/tasks?site_id=123
{
"task_id": "makeup_final_list",
"checked": true
}Response parameters
If successful, the server returns the 200 HTTP status code.
Response example
No response body.
