Skip to content
Ishvana Ishvana Docs

Update Timeline

PUT
/api/creative/timelines/{timeline_id}

Update an existing timeline’s metadata.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
timeline_id
required
Timeline Id
string

Request Body required

Section titled “Request Body required ”
TimelineUpdateRequest

PUT /timelines/{id} body — all fields optional.

object
name
Any of:
string
description
Any of:
string
worldId
Any of:
string
scale
Any of:
TimelineScale
string
Allowed values: years decades centuries
startDate
Any of:
string
endDate
Any of:
string
calendarSystemId
Any of:
string
tags
Any of:
Array<string>
viewMode
Any of:
TimelineViewMode
string
Allowed values: linear swimlane overview

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

TimelineResponse

Single timeline response.

object
status
required
Status

Operation status

string
data
required
Timeline

Timeline data

object
id
Any of:
string
name
required
Name

Timeline name

string
description
Description

Description

string
""
worldId
Any of:
string
scale
TimelineScale

Time scale

string
default: years
Allowed values: years decades centuries
startDate
Startdate

Start date

string
default: 0000
endDate
Enddate

End date

string
default: 9999
calendarSystemId
Any of:
string
created
Any of:
integer
modified
Any of:
integer
tags
Tags

Tags

Array<string>
viewMode
TimelineViewMode

Active view mode

string
default: linear
Allowed values: linear swimlane overview

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object