Create A Simple Inbound Flow with API POST in CLI

[Kappen]

Hi,

Is there a way to create a very simple Inbound Call flow through POST /api/v2/flows ?
Each time I try, the result is a locked flow with no configuration. I'm looking to use this API call to just create a very simple flow as basically a placeholder. I'm aware that ARCHY is the tool to import flows but I was wondering if there was a way to create a simple flow through the API call.

Thanks!

[jacobshaw]

Hi @Kappen
If you want to create a flow with configuration using the API, you can use POST /api/v2/flows/jobs As the resource descriptions states:

Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.

Then you would add the file contents of a YAML configuration file to the request body of a PUT request the presigned URL.

It's worth noting that using our CX as Code offering would simplify that. Our Terraform provider includes a flow resource. Terraform Registry

[tim.smith]

I strongly recommend using Archy, but if you are looking for a direct API option, check out the JavaScript Flow Scripting SDK. This SDK is different from the Platform API SDKs in that it is written to provide logical wrappers around flow functionality, as opposed to a 1:1 wrapper around API endpoints. You can decompose the logic in this SDK to use the API endpoints directly if you're not using JavaScript, but that's a bit like telling you you're able to open up the hood of your car and rebuild the engine if you look at how it works. The API endpoints are pretty gnarly to use directly since you have to have a lot of knowledge about how flows must be structured to use the endpoints successfully.