Update a pathway

put

https://api.superpath.io/pathways/{pathwayId}

Update an existing pathway

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

pathwayId

string

required

The ID of the pathway

Body Params

title

string

Title of the pathway

subTitle

string

Subtitle of the pathway

description

string

Description of the pathway

image

string

Image URL for the pathway

cover

string

Cover image or video URL

coverIsImage

boolean

Whether the cover is an image

friendlyUrl

string

SEO-friendly URL slug

stepOrder

array of strings

Ordered array of step IDs

stepOrder

overridePoints

boolean

Whether to override default points

customPoints

int32

Custom gamification points

cpdPoints

int32

CPD points awarded

isPublic

boolean

Whether the pathway is publicly accessible

length

string

Duration of the pathway

lengthUnit

string

enum

Unit of duration

Allowed:

level

string

Difficulty level

isPaid

boolean

Whether the pathway requires payment

additionalCost

number

Additional cost if paid

additionalCostCurrency

string

Currency for additional cost

tags

categoryId

string

Category ID

categoryTitle

string

Category title

subCategoryId

string

Sub-category ID

subCategoryTitle

string

Sub-category title

topicCategoryId

string

Topic category ID

topicCategoryTitle

string

Topic category title

autoAssign

boolean

Whether to auto-assign to users

ownerId

string

Owner user ID

viewers

array of strings

User IDs with view access

viewers

editors

array of strings

User IDs with edit access

editors

approvalRequired

boolean

Whether completion requires approval

isSearchable

boolean

Whether pathway is searchable

instructorId

string

Instructor user ID

allowJourney

boolean

Whether journey view is enabled

journeyBackgroundImage

string

Journey background image URL

journeyBackgroundColour

string

Journey background color

journeyTextColour

string

Journey text color

journeyPathType

string

Journey path visualization type

journeyOrientation

string

Journey orientation

syncWithHRIS

boolean

Whether to sync with HRIS

externalId

string

External system ID

restrictedTeamIds

array of strings

Team IDs with restricted access

restrictedTeamIds

status

string

Status of the pathway

timezoneOffset

int32

Timezone offset of the requesting location

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

204The record was succesfully updated

400The server could not understand the request due to invalid syntax

401The auth token provide is missing or invalid

404The specified resource was not found