Get Flow Message

GET {{baseUrl}}/api/flow-messages/:id/

Get the flow message of a flow with the given message ID. Include parameters can be provided to get the following related resource data: 'flow-actions'

Rate limits:
Burst: 3/s
Steady: 60/m

Scopes: Flows Read

Request Params

KeyDatatypeRequiredDescription
fields[flow-action]stringFor more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
fields[flow-message]stringFor more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
includestringFor more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships
includestringFor more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#relationships

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Acceptstring

RESPONSES

status: OK

{"data":{"type":"flow-message","id":"magna occaecat culpa","attributes":{"name":"fugiat sint nostrud laborum","channel":"consectetur consequat enim et","content":{"subject":"velit nulla","preview_text":"mol","from_email":"labore eiusmod Duis officia","from_name":"ullamco incididunt id"},"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"http://c.baBPB30znSiLQjI9vVO+B,JNKpkqLpET7XLVgDkLB27kIVl1AKFcwi"},"relationships":{"flow-action":{"data":{"type":"flow-action","id":"culpa ut"}}}},"included":[{"type":"flow-action","id":"deserunt elit","attributes":{"action_type":"fugiat ex","status":"sunt dolor","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","settings":{},"tracking_options":{"add_utm":false,"utm_params":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"is_tracking_opens":false,"is_tracking_clicks":true},"send_options":{"use_smart_sending":true,"is_transactional":true},"render_options":{"shorten_links":true,"add_org_prefix":false,"add_info_link":false,"add_opt_out_language":true}},"links":{"self":"http://AmmHmBkCQN.yonbAlWrV0zGE"}},{"type":"flow-action","id":"aliquip","attributes":{"action_type":"ut","status":"tempor sed","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","settings":{},"tracking_options":{"add_utm":true,"utm_params":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"is_tracking_opens":true,"is_tracking_clicks":true},"send_options":{"use_smart_sending":true,"is_transactional":false},"render_options":{"shorten_links":true,"add_org_prefix":false,"add_info_link":false,"add_opt_out_language":true}},"links":{"self":"http://QSORgrORQCfcAxOwTXTAFyYRmzBJDyFQs.ixfs03KIJZoSuDFFXH4"}}]}