Flows

Trigger an api-entries block in a flow

Auth policies: User

Use this endpoint to trigger an api entry block in a flow.

Call this endpoint with the same jsonBody you used when mapping the block (must be done before calling this)

Options (optional):

If you choose to include the options you must pass the contacts like this:

{
    "options": {
        "addToSegment": "segments.customers", //"status.active" etc.
        "clearSegment": true, //if true, removes the segment values from all other contacts
        "enableValidation": false, //if true, response includes an array of non-imported contacts
    },
    "contacts": [{
        "firstName": "",
        ...
    },
    ...
    ]
}

Example of response if enableValidation is true

{
	status: "error|success",
	errors: [
		"email: 'test@test@gftdf.no' failed at line 123",
		"mobile: '+95678762 4' failed at line 23",
	]
}

NOTE: Partial validation fails will return a 200 (OK), so be sure to check the errors array in the response. If all contacts fails, a 400 (BadRequest) is returned.

NOTE: When useBackgroundTask=true, the response is returned before the complete payload has been processed. This can be used to prevent request timeouts. Please note that validation messages will not be returned in the response (status code 202 - Accepted).

post/flows/{flowId}/api-entries/{blockId}

Request

  • Base URL: https://api.loopify.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.loopify.com/flows/{flowId}/api-entries/{blockId}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.loopify.com/connect/authorize, token URL https://auth.loopify.com/token, scopes: User)

Path parameters

flowIdstring required
blockIdstring required

Query parameters

useBackgroundTaskboolean

Payload will be processed in a background task - response (202) is returned early

Request body

unknown required

Response

Success

statusstring nullable
errorsstring[] nullable

Changes

No recorded changes to this operation across all 1 revision of this API.