Skip to main content
PUT
Update a lesson

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Path Parameters

id
string
required

The id identifier.

Query Parameters

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Body

application/json
name
string

Updated lesson name.

tags
string[]

Updated tag list for the lesson.

uuid
string

Alternative identifier. When present this is used instead of the path id.

restore
boolean

Restore a soft-deleted lesson. Consumed as a control flag; not stored on the record.

deleted_at
string | null

Set to null together with restore to bring the lesson back.

folder_id
string | null

Destination folder. On restore a deleted parent folder falls back to an available one.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

A lesson.