Update

Description

Update a story.

Request

HTTP Method: PUT

Query Parameter Description
name Optional The story name.
description Optional A user-defined description of the story.
add_tag_names Optional An array of tag names to add to the story.
remove_tag_names Optional An array of tag names to remove from the story.
keep_events_for Optional Event retention period in seconds:
1 hour: 3600
6 hours: 21600
1 day: 86400
3 days: 259200
7 days: 604800
14 days: 1209600
30 days:2592000
60 days:5184000
90 days:7776000
180 days:15552000
365 days: 31536000
disabled Optional Boolean flag indicating whether the story is disabled from running.
locked Optional Boolean flag indicating whether the story is locked, preventing edits.
priority Optional Boolean flag indicating whether story runs with high priority.
send_to_story_enabled Optional Boolean flag indicating if Send to Story is enabled.
send_to_story_access Optional Controls who is allowed to send to this story (TEAM, GLOBAL, SPECIFIC_TEAMS). default: TEAM.
shared_team_slugs Optional List of teams' slugs that can send to this story. Required to set send_to_story_access to SPECIFIC_TEAMS. default: [] (empty array).
entry_agent_id Optional The ID of the entry action for this story (action must be of type Webhook).
exit_agent_ids Optional An Array of IDs describing exit actions for this story (actions must be message-only mode event transformation).
team_id Optional The ID of the team to move the story to.
folder_id Optional The ID of the folder to move the story to, or an empty value to indicate the root folder. Note that this folder must exist within the team identified by team_id, or the story's current team if team_id isn't specified.
Path Parameter Description
story_id The ID of the story.

Sample request

curl -X PUT \
  https://<<META.tenant.domain>>/api/v1/stories/<<story_id>> \
  -H 'content-type: application/json' \
  -H 'x-user-token: <api-token>' \
  -d '{
        "name": "Updated Simple story",
        "description": "Updates story description"
      }'

Response

A successful request will return a JSON object describing the updated story

Field description

Parameter Description
id The story ID.
name The story name.
user_id ID of story owner.
description A user-defined description of the story.
created_at ISO 8601 Timestamp representing date and time the story was created.
updated_at ISO 8601 Timestamp representing date and time the story was last updated.
keep_events_for Defined event retention period in seconds.
disabled Boolean flag indicating whether story is disabled from running.
locked Boolean flag indicating whether story is locked, preventing edits.
priority Boolean flag indicating whether story runs with high priority.
tags An array of tags used to classify the story.
guid Unique identifier of the story.
team_id ID of team to which the story belongs.
folder_id ID of folder to which the story belongs.
send_to_story_enabled Boolean flag indicating if Send to Story is enabled.
send_to_story_access Controls who is allowed to send to this story (TEAM,GLOBAL,SPECIFIC_TEAMS).
shared_team_slugs List of teams' slugs that can send to this story when send_to_story_access is SPECIFIC_TEAMS, otherwise empty.
change_control_enabled Boolean flag indicating if change control is enabled.
entry_agent_id The ID of the entry action for this story.
exit_agents An Array of objects describing exit actions for this story.
slug An underscored representation of the story name.
published Boolean flag indicating the published state of the story.

Sample response

{
  {
    "name": "Updated Simple story",
    "user_id": 1,
    "description": "Updates story description",
    "keep_events_for": 86400,
    "disabled": false,
    "priority": false,
    "send_to_story_enabled": false,
    "send_to_story_access": null,
    "shared_team_slugs": [],
    "entry_agent_id": null,
    "exit_agents": [],
    "team_id": 2,
    "story_container": {
      "id": 1,
      "team_id": 2,
      "folder_id": 1,
      "published": true,
      "locked": false,
      "change_control_enabled": false
    },
    "tags": [],
    "guid": "7e46421f98f598157fc5f55082b96f39",
    "slug": "updated_simple_story",
    "created_at": "2023-08-02T14:29:34Z",
    "updated_at": "2023-09-20T14:03:49Z",
    "edited_at": "2023-09-20T13:45:18Z",
    "id": 1,
    "folder_id": 1,
    "published": true,
    "locked": false,
    "change_control_enabled": false
  }
}
Was this helpful?