POST Api/V1/Journey/TriggerExternalFlow

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
FlowId		integer	Required
Leads		Collection of TriggerExternalFlowLeadRequest	Required

Request Formats

application/json, text/json

Sample:

{
  "FlowId": 1,
  "Leads": [
    {
      "LeadId": 1,
      "ExternalFields": {
        "sample string 1": {},
        "sample string 3": {}
      }
    },
    {
      "LeadId": 1,
      "ExternalFields": {
        "sample string 1": {},
        "sample string 3": {}
      }
    }
  ]
}

application/xml, text/xml

Sample:

<TriggerExternalFlowRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iCreate.API.Controllers">
  <FlowId>1</FlowId>
  <Leads>
    <TriggerExternalFlowLeadRequest>
      <ExternalFields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </ExternalFields>
      <LeadId>1</LeadId>
    </TriggerExternalFlowLeadRequest>
    <TriggerExternalFlowLeadRequest>
      <ExternalFields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </ExternalFields>
      <LeadId>1</LeadId>
    </TriggerExternalFlowLeadRequest>
  </Leads>
</TriggerExternalFlowRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TriggerExternalFlowRequest'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.