Core APIs
Core Bulk
3 min
the bulk api is expected to be used with a large number of rows the bulk process runs asynchronously and calls an automation endpoint on completion its best to use this when you are expecting a process to run over for more than a minute there are three parts to this api input is expected to be a large list of json objects functions a list of any of the core functions in the function json representation format defined here output an output definition for each of the items in the input list there is a minor difference in the way the functions list is created follow the example in the api for clarity this will be aligned in future releases of the bulk api webhooks in this api name description completion required the api will be rejected without a valid automation url this is where the output along with the "process name" will be sent as a post resquest progress optional use this to track the progress of api this works in conjunction with progress rows and sends a progress notification for every n rows (100 in this example) error optional useful to track any failure the error notification works on every item of the list that is being processed any error will not stop processing but will send a notification to he url specified and continue to process the remaining items api definition tab examples url https orca pathfix com functions bulk name multi functions api method post request pathparameters queryparameters headerparameters bodydataparameters formdataparameters results languages id 28usdqyeh3qrdmtvamsqt code n output processing asynchronously n language 200 id yix64dyiudpjgbrfsfawb code n message error n language 404 selectedlanguageid 28usdqyeh3qrdmtvamsqt examples languages id encjz9tstg38f0x taa4x code r n input r n r n user id ron4 pathfix com r n source facebook r n country india r n r n r n user id janet pathfix com r n source linkedin r n country india r n r n r n functions r n switch source r n type text r n function multiswitch r n params r n switches r n source r n input function input source r n switch r n facebook facebook r n facebook facebook r n linkedin linkedin r n r n r n countrycode r n input function input country r n switch r n india in r n r n r n r n r n r n to base64 r n type text r n function tobase64 r n params r n input function input user id function switch source output source r n r n r n r n output r n email user id r n source function switch source output source r n address r n country cde function switch source output countrycode r n r n base64 function to base64 output r n r n webhooks r n completion https run pathfix com flow 5594f54e f3ed 49c8 89ec f87ae102719a r n progress https run pathfix com flow 5594f54e f3ed 49c8 89ec f87ae102719a r n error https run pathfix com flow 5594f54e f3ed 49c8 89ec f87ae102719a r n progress rows 100 r n r n process name async conversion r n language json selectedlanguageid encjz9tstg38f0x taa4x description ncall the following api currentnewparameter label body parameter value bodydataparameters