Update a story
Update a story. Defaults to a draft called "test" if change control is enabled on the story and no draft_id is provided.
Request
- Base URL: https://your-tenant.tines.com
- URL: https://your-tenant.tines.com/api/v1/stories/{id}
- Auth: one of:
- API key in header X-User-Token
- HTTP bearer
Path parameters
The ID of the story
Request body
The story name
A user-defined description of the story
An array of tag names to add to the story
An array of tag names to remove from the story
Event retention period in seconds. One of 3600, 21600, 86400, 259200, 604800, 1209600, 2592000, 5184000, 7776000, 15552000, or 31536000
Whether the story is disabled from running
Whether the story is locked, preventing edits
Whether the story runs with high priority
Whether webhook API is enabled. If enabling, api_entry_action_id and api_exit_action_ids must also be specified
The ID of the entry action for this API enabled story (action must be of type webhook)
An array of IDs describing exit actions for this API enabled story
Indicates if send to story is enabled and where it can be used. If enabling, entry_action_id and exit_action_ids must also be specified
The ID of the entry action for this send to story enabled story (action must be of type webhook)
An array of IDs describing exit actions for this send to story enabled story
Controls who is allowed to send to this story. If using SPECIFIC_TEAMS must also specify shared_team_slugs
List of teams' slugs that can send to this story. Required to set send_to_story_access to SPECIFIC_TEAMS
Whether Workbench should ask for confirmation before running this story
The ID of the team to move the story to
The ID of the folder to move the story to, or an empty value for the root folder
Whether change control is enabled
The ID of the draft to update
Whether monitor failures is enabled on the story
Response
Successful response
Story ID
Story name
ID of the story creator
User-defined description of the story
Event retention period in seconds
Whether the story is disabled
Whether the story is high priority
Whether Send to Story is enabled
Where Send to Story can be used (STS, STS_AND_WORKBENCH, WORKBENCH, OFF)
Who is allowed to send to this story (TEAM, GLOBAL, SPECIFIC_TEAMS)
IDs of stories that call this Send to Story enabled story. Only present when send_to_story_enabled is true
Slugs of teams that can send to this story when send_to_story_access is SPECIFIC_TEAMS, otherwise empty
Whether a timeout is enabled for Send to Story runs
Maximum time in seconds a Send to Story run may take before timing out. Only takes effect when send_to_story_timeout_enabled is true. null if no duration has been set
Whether Workbench should ask for confirmation before running this story
ID of the entry action for this story
Objects describing exit actions for this story
ID of the team to which the story belongs
Tags used to classify the story
Unique identifier of the story
Underscored representation of the story name
ISO 8601 timestamp of when the story was created
ISO 8601 timestamp of when the story row was last updated
ISO 8601 timestamp of when the story was last logically updated
Mode of the story (LIVE or TEST)
ID of the folder to which the story belongs
Whether the story is published
Whether change control is enabled
Whether the story is locked to changes
IDs of users listed as owners on the story
Whether monitor failures is enabled on all actions in the story
IDs of actions with monitoring enabled
Monitoring recipients for the story
Changes
No recorded changes to this operation across all 1 revision of this API.