Health
Workflow Executions
Create a Workflow Execution
POST
/
workflows
/
{workflowId}
/
executions
Copy
curl --request POST \
--url https://prod.featherhq.com/workflows/{workflowId}/executions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"leadId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"primaryPhone": "<string>",
"zipcode": "<string>",
"referenceURL": "<string>",
"city": "<string>",
"state": "<string>",
"sourceID": "<string>",
"campaignID": "<string>",
"phoneAgentExtension": "<string>",
"phoneAgentDirectDial": "<string>",
"textContent": "<string>",
"forwardingPhoneNumber": "<string>"
}'
Copy
{
"id": "<string>",
"workflowId": "<string>",
"status": "CREATED",
"temporalWorkflowId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"steps": [
{
"id": "<string>",
"workflowExecutionId": "<string>",
"type": "CALL",
"order": 123,
"delayInSecs": 123,
"status": "PENDING",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"result": "<any>",
"error": "<string>",
"callId": "<string>",
"call": {
"id": "<string>",
"status": "INITIATED",
"callStartedAt": "2023-11-07T05:31:56Z",
"callEndedAt": "2023-11-07T05:31:56Z",
"callEndedReason": "NO_ANSWER"
},
"needsTCPACompliance": true,
"finishOn": [
"NO_ANSWER"
],
"voicemailMessage": "<string>"
}
],
"metadata": {
"leadId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"primaryPhone": "<string>",
"zipcode": "<string>",
"referenceURL": "<string>",
"city": "<string>",
"state": "<string>",
"sourceID": "<string>",
"campaignID": "<string>",
"phoneAgentExtension": "<string>",
"phoneAgentDirectDial": "<string>",
"borrowerState": "AL",
"forwardingPhoneNumber": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"receivedCallBack": false,
"callBackCallId": "<string>",
"phoneNumberId": "<string>"
}
Authorizations
Path Parameters
Body
application/json
Response
201
application/json
Workflow execution created successfully
The response is of type object
.
Copy
curl --request POST \
--url https://prod.featherhq.com/workflows/{workflowId}/executions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"leadId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"primaryPhone": "<string>",
"zipcode": "<string>",
"referenceURL": "<string>",
"city": "<string>",
"state": "<string>",
"sourceID": "<string>",
"campaignID": "<string>",
"phoneAgentExtension": "<string>",
"phoneAgentDirectDial": "<string>",
"textContent": "<string>",
"forwardingPhoneNumber": "<string>"
}'
Copy
{
"id": "<string>",
"workflowId": "<string>",
"status": "CREATED",
"temporalWorkflowId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"steps": [
{
"id": "<string>",
"workflowExecutionId": "<string>",
"type": "CALL",
"order": 123,
"delayInSecs": 123,
"status": "PENDING",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"result": "<any>",
"error": "<string>",
"callId": "<string>",
"call": {
"id": "<string>",
"status": "INITIATED",
"callStartedAt": "2023-11-07T05:31:56Z",
"callEndedAt": "2023-11-07T05:31:56Z",
"callEndedReason": "NO_ANSWER"
},
"needsTCPACompliance": true,
"finishOn": [
"NO_ANSWER"
],
"voicemailMessage": "<string>"
}
],
"metadata": {
"leadId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"primaryPhone": "<string>",
"zipcode": "<string>",
"referenceURL": "<string>",
"city": "<string>",
"state": "<string>",
"sourceID": "<string>",
"campaignID": "<string>",
"phoneAgentExtension": "<string>",
"phoneAgentDirectDial": "<string>",
"borrowerState": "AL",
"forwardingPhoneNumber": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"receivedCallBack": false,
"callBackCallId": "<string>",
"phoneNumberId": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.