Parameters (POST/PUT)

There are few parameters available within POST and PUT requests.

createRelations

This parameter has been included to allow Clients to check if a Relation exists and if not, provide an error that can be captured.

The default action for Re-flow is to create any new/missing Relations as part of an Import. The Re-Flow CSV importer, for example, gives the option to create missing relations. Relations are records such as Companies or Sites that you have included in your import. The API adds these missing relations by default, even if the createRelations parameter is not passed.

In the example below we are creating a Job/Project and using the createRelations parameter within the URL. It is set to ‘false’ which ensures that the API will check that Client. In this example ‘Amey LG_TEST’, exists within Re-flow, and if not, prompt with a relevant response and not create the Job.

Open

 Making a PUT Request

This is used for updating entities within Re-flow.

Please note that the id of the entity needs to be used here within the request.

https://exampleSite.re-flow.co.uk/v1/api/accounts/invoice/8064

The Body should contain the changes being made.

Open