Skip to main content

Update

Description

Update a story.

Request

HTTP Method: PUT

Query ParameterDescription
nameOptional The story name.
descriptionOptional A user-defined description of the story.
keep_events_forOptional Event retention period in seconds:
1 hour: 3600
6 hours: 21600
1 day: 86400
3 days: 259200
7 days: 604800
30 days: 2592000
365 days: 31536000
disabledOptional Boolean flag indicating whether the story is disabled (default: false)
priorityOptional Boolean flag indicating if this is a high priority story (default: false).
send_to_story_enabledOptional Boolean flag indicating if Send to Story is enabled (default: false).
send_to_story_accessOptional Controls who is allowed to send to this story ( TEAM or GLOBAL).
entry_agent_idOptional The ID of the entry action for this story (Action must be of type Webhook)
exit_agent_idsOptional An Array of IDs describing exit actions for this story (Actions must be message-only mode event transformation).
published_stateOptional Indicates the published state of the story. Takes PUBLISHED or UNPUBLISHED. The story must be in a team and not user drafts to be published.
emit_held_eventsOptional Used in conjunction with published_state. When updating published state to PUBLISHED, pass in true for emit_held_events, to emit all held events in the story.
Path ParameterDescription
story-idID of the story

Sample request

curl -X PUT \
https://<tenant-domain>/api/v1/stories/<story-id> \
-H 'content-type: application/json' \
-H 'x-user-email: <email-address>' \
-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

ParameterDescription
idThe story ID.
nameThe story name.
user_idID of story owner.
descriptionA user-defined description of the story.
created_atISO 8601 Timestamp representing date and time the story was created.
updated_atISO 8601 Timestamp representing date and time the story was last updated.
keep_events_forDefined event retention period in seconds.
disabledBoolean flag indicating whether story is disabled.
priorityBoolean flag indicating whether story is hight priority story.
guidUnique identifier of the story.
team_idID of team to which the story belongs.
folder_idID of folder to which the story belongs.
send_to_story_enabledBoolean flag indicating if Send to Story is enabled.
send_to_story_accessControls who is allowed to send to this story.
entry_agent_idThe ID of the entry action for this story.
exit_agentsAn Array of objects describing exit actions for this story.
slugAn underscored representation of the story name.
publishedBoolean flag indicating the published state of the story.

Sample response

{
"id": 7981,
"name": "Updated Simple story",
"user_id": 167,
"description": "Updates story description",
"keep_events_for": 604800,
"disabled": false,
"priority": false,
"send_to_story_enabled": false,
"send_to_story_access": null,
"entry_agent_id": null,
"exit_agents": [],
"team_id": 1,
"folder_id": 1,
"guid": "df1e838a18d20696120b41516497b017",
"slug": "updated_simple_story",
"created_at": "2021-05-10T08:56:50Z",
"updated_at": "2021-05-10T09:56:50Z",
"published": false
}