Update a welcome widget task for the given user Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
"PlannrCRM MCP server": {
  "url": "https://apidocs.plannrcrm.com/mcp"
}
Close
POST /api/v1/my/welcome-widget-tasks/{id}

Only available to Plannr's front-end.

Path parameters

  • id string Required

    The ID of the welcome widget task.

application/json

Body

  • is_complete boolean Required

    Denotes if a welcome widget item is complete.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • id string

      The ID of the welcome widget item.

    • title string

      The title of the welcome widget item.

    • description string

      The description of the welcome widget item.

    • type string

      The type of welcome widget item. Available values: video and document

    • resource_url string

      The URL of the resource depending on the type.

    • is_complete boolean

      Denotes if the welcome widget task has been completed by the authenticated user.

POST /api/v1/my/welcome-widget-tasks/{id}
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/my/welcome-widget-tasks/architecto' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"is_complete":true}'
Request examples
{
  "is_complete": true
}
Response examples (200)
{
  "id": "branding",
  "title": "Personalise your branding",
  "description": "Let's make Plannr look like the rest of your company",
  "type": "video",
  "resource_url": "https://www.youtube.com/embed/7siXdMId640",
  "is_complete": false
}