{"_id":"57fcc4870312b20e00ac6521","user":"54497cce27b7fc140078d9a5","parentDoc":null,"__v":0,"category":{"_id":"57fcc4860312b20e00ac64ca","version":"57fcc4860312b20e00ac64c0","__v":0,"project":"5435687035740020002a1c04","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-30T22:39:02.374Z","from_sync":false,"order":9,"slug":"flow-data-structures","title":"Flow Data Structures"},"project":"5435687035740020002a1c04","version":{"_id":"57fcc4860312b20e00ac64c0","project":"5435687035740020002a1c04","__v":1,"createdAt":"2016-10-11T10:52:54.637Z","releaseDate":"2016-10-11T10:52:54.637Z","categories":["57fcc4860312b20e00ac64c1","57fcc4860312b20e00ac64c2","57fcc4860312b20e00ac64c3","57fcc4860312b20e00ac64c4","57fcc4860312b20e00ac64c5","57fcc4860312b20e00ac64c6","57fcc4860312b20e00ac64c7","57fcc4860312b20e00ac64c8","57fcc4860312b20e00ac64c9","57fcc4860312b20e00ac64ca","57fcc4860312b20e00ac64cb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"[APP-1265], [APP-1035]","version_clean":"5.2.0","version":"5.2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-31T23:12:04.301Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"lua","name":"Agent Lua","code":"output.text = \"Hello World\""}]},"method":"post","results":{"codes":[{"name":"","code":"{\n    \"errors\": [\n    ],\n    \"skipped\": [\n    ],\n    \"updated\": [\n    \t\"your_flow_tag\"\n    ]\n}","language":"json","status":200},{"name":"","code":"{\n    \"errors\": [\n        \"error description\"\n    ],\n    \"skipped\": [\n    \t\"your_flow_tag\"\n    ],\n    \"updated\": [\n    ]\n}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"_id":"5682d63feb6f4c0d00e89de7","ref":"","in":"path","required":true,"desc":"The flow tag","default":"","type":"string","name":"text_flow_tag"},{"_id":"5682d63feb6f4c0d00e89de6","ref":"","in":"body","required":true,"desc":"The text to display. Supports a newline character \\n to wrap text","default":"","type":"string","name":"text"},{"_id":"5682d63feb6f4c0d00e89de5","ref":"","in":"body","required":false,"desc":"Whether to align the text. Defaults to center.  One of: \"left\", \"right\", \"center\"","default":"","type":"string","name":"alignment"},{"_id":"5682d63feb6f4c0d00e89de4","ref":"","in":"body","required":false,"desc":"Font size of the text. Defaults to normal.","default":"","type":"string","name":"size"},{"_id":"5682d63feb6f4c0d00e89de3","ref":"","in":"body","required":false,"desc":"CSS color of the text","default":"","type":"string","name":"color"}],"url":"/flows/:text_flow_tag/metrics"},"isReference":false,"order":18,"body":"[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/bAMaBgIyQlGJd85yYK0C_text3.png\",\n        \"text3.png\",\n        \"800\",\n        \"141\",\n        \"#a48870\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"Text flows are simple flows whose flow displays a text. It may optionally contain an alignment.","slug":"text","type":"endpoint","title":"Text"}

postText

Text flows are simple flows whose flow displays a text. It may optionally contain an alignment.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

text_flow_tag:
required
string
The flow tag

Body Params

text:
required
string
The text to display. Supports a newline character \n to wrap text
alignment:
string
Whether to align the text. Defaults to center. One of: "left", "right", "center"
size:
string
Font size of the text. Defaults to normal.
color:
string
CSS color of the text

Examples


Result Format


Documentation

[block:image] { "images": [ { "image": [ "https://files.readme.io/bAMaBgIyQlGJd85yYK0C_text3.png", "text3.png", "800", "141", "#a48870", "" ] } ] } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}