Update a welcome widget task for the given user

POST /api/v1/my/welcome-widget-tasks/{id}

Only available to Plannr's front-end.

Headers

Path parameters

  • id string Required

    The ID of the welcome widget task.

application/json

Body Required

  • 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 \
 -X POST https://api.plannrcrm.com/api/v1/my/welcome-widget-tasks/id \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"is_complete":true}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "is_complete": true
}
Response examples (200) 
{
  "id": "branding",
  "type": "video",
  "title": "Personalise your branding",
  "description": "Let's make Plannr look like the rest of your company",
  "is_complete": false,
  "resource_url": "https://www.youtube.com/embed/7siXdMId640"
}