Configuration API: Flows

API endpoints for managing flows and flow components, including forms, fields, screens, and transactional emails.

In addition to reference information for each endpoint, this section of the documentation includes the following article:





EndpointMethods
/config/{appId}/flows     
View information about your flows.
  • GET
/config/{appId}/flows/{flow}
Use the GET method to view information about the specified flow. Use the PUT method to update the userData and/or entity types associated with a flow.
  • GET
  • PUT
/config/{appId}/flows/{flow}/2faMessages
Adds the default set of  two-factor authentication messages to a flow.
  • POST

/config/{appId}/flows/{flow}/copy
Create a new flow by copying an existing flow.
  • POST
/config/{appId}/flows/{flow}/fields
Use the GET method to view the fields defined in a flow. Use the POST method to define a new field.
  • GET
  • POST
/config/{appId}/flows/{flow}/fields/{field}
Use the GET method to view the specified field. Use the PUT method to update a field and the DELETE method to remove a field from a flow.
  • GET
  • PUT
  • DELETE
/config/{appId}/flows/{flow}/forms
Use the GET method to view the forms associated with a flow. Use the POST method to create a form.
  • GET
  • POST
/config/{appId}/flows/{flow}/forms/{form}
Use the GET method to view the specified form. Use the PUT method to update a form, and the DELETE method to remove a form from a flow.
  • GET
  • PUT
  • DELETE
/config/{appId}/flows/{flow}/links
Use the GET method to view the Hosted Login links defined in a flow. Use the POST method to add a link to a flow.
  • GET
  • POST
/config/{appId}/flows/{flow}/links/{link}
Use the GET method to view the specified link. Use the PUT method to modify a link and the DELETE method to remove a link from a flow.
  • GET
  • PUT
  • DELETE
/config/{appId}/flows/{flow}/locales
View the locales defined in a flow. Locales represent a specific language, region, and collection of locale variant preferences.
  • GET
/config/{appId}/flows/{flow}/locales/{locale}/2faMessages
Returns information about the two-factor authentication messages contained in a flow. 
  • GET

/config/{appId}/flows/{flow}/locales/{locale}/2faMessages/{message}
The GET method returns information about the specified two-factor authentication message. The PUT method enables you to modify the specified message.
  • GET
  • PUT

/config/{appId}/flows/{flow}/locales/{locale}
View the specified locale. Locales represent a specific language, region, and collection of locale variant preferences
  • GET
/config/{appId}/flows/{flow}/locales/{locale}/fields
Use the GET method to view the fields associated with the specified locale. Use the POST method to add a field to a locale.
  • GET
  • POST
/config/{appId}/flows/{flow}/locales/{locale}/mailTemplates
View the mail templates associated with the specified locale.
  • GET
/config/{appId}/flows/{flow}/locales/{locale}/mailTemplates/{template}
Use the GET method to view the specified mail template associated with the specified locale. Use the PUT method to modify a mail template (both the mail body and the mail subject line).
  • GET
  • PUT
/config/{appId}/flows/{flow}/locales/{locale}/mailTemplates/{template}/body
Use the GET method to view the body text for the specified mail template. Use the PUT method to modify the body text (both plain-text and HTML) for a mail template. 
  • GET
  • PUT
/config/{appId}/flows/{flow}/locales/{locale}/mailTemplates/{template}/subject
Use the GET method to view the subject line for the specified mail template. Use the PUT method to modify subject line for a mail template.
  • GET
  • PUT

/config/{appId}/flows/{flow}/locales/{locale}/strings
Use the GET method to view all the strings defined in the specified locale of a flow. Use the POST method to add a string to a locale.
  • GET
  • POST

/config/{appId}/flows/{flow}/locales/{locale}/strings/{string}
Use the GET method to view a string in the specified locale of a flow. Use the PUT method to modify a string, and use the DELETE method to remove a string from a locale.
  • GET
  • PUT
  • DELETE

/config/{appId}/flows/{flow}/promote
"Promotes" (i.e., copies) a flow from one application to another.
  • POST

/config/{appId}/flows/{flow}/screens
Use the GET method to view the screens defined in a flow. Use the POST method to assign a new screen to a flow.
  • GET
  • POST

/config/{appId}/flows/{flow}/screens/{screen}
Use the GET method to view the specified screen. Use the PUT method to update a screen and the DELETE method to remove a screen from a flow.
  • GET
  • PUT
  • DELETE

/config/{appId}/flows/{flow}/strings
Use the GET method to view all the strings defined in a flow. Use the POST method to add a string to a flow.
  • GET
  • POST

/config/{appId}/flows/{flow}/strings/{string}
Use the GET method to view the specified sting. Use the PUT method to modify a string and use the DELETE method to remove a string from a flow.
  • GET
  • PUT
  • DELETE

/config/{appId}/flows/{flow}/translations
Use the GET method to view the specified translation.  Use the PATCH method to modify a translation and the POST method to remove a translation from a flow.
  • GET
  • PATCH
  • POST
/config/{appId}/flows/{flow}/translations/{keyId}    
Use the GET method to view all the translations associated with the specified translation key. Use the DELETE method to remove all the translations associated with a translation key.
  • GET
  • DELETE

/config/{appId}/flows/{flow}/versions
View versions (and change data) for the specified flow.
  • GET

/config/{appId}/flows/{flow}/versions/{versionId}
Use the GET method to view the specified version of a flow. Use the POST method to restore a flow to the specified version.
  • GET
  • POST