Runs an automation through its Manual trigger.

curl --request POST \
  --url https://api.leadping.ai/automations/{id}/run \
  --header 'Authorization: Bearer <token>'

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/automations/{id}/run");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.leadping.ai/automations/{id}/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leadping.ai/automations/{id}/run"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/automations/{id}/run",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "<string>",
  "automationId": "<string>",
  "organizationId": "<string>",
  "leadId": "<string>",
  "triggerType": "<string>",
  "status": "<string>",
  "executionMode": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "processingAttempts": 123,
  "lastAttemptAt": "2023-11-07T05:31:56Z",
  "failureCode": "<string>",
  "skippedReason": "<string>",
  "actions": [
    {
      "id": "<string>",
      "automationRunId": "<string>",
      "actionId": "<string>",
      "actionType": "<string>",
      "order": 123,
      "status": "<string>",
      "selectedConnectionId": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "scheduledAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "failedAt": "2023-11-07T05:31:56Z",
      "processingAttempts": 123,
      "nextRetryAt": "2023-11-07T05:31:56Z",
      "failureCode": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

POST

automations

{id}

run

Runs an automation through its Manual trigger.

curl --request POST \
  --url https://api.leadping.ai/automations/{id}/run \
  --header 'Authorization: Bearer <token>'

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/automations/{id}/run");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.leadping.ai/automations/{id}/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.leadping.ai/automations/{id}/run"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.leadping.ai/automations/{id}/run",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "<string>",
  "automationId": "<string>",
  "organizationId": "<string>",
  "leadId": "<string>",
  "triggerType": "<string>",
  "status": "<string>",
  "executionMode": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "processingAttempts": 123,
  "lastAttemptAt": "2023-11-07T05:31:56Z",
  "failureCode": "<string>",
  "skippedReason": "<string>",
  "actions": [
    {
      "id": "<string>",
      "automationRunId": "<string>",
      "actionId": "<string>",
      "actionType": "<string>",
      "order": 123,
      "status": "<string>",
      "selectedConnectionId": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "scheduledAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "failedAt": "2023-11-07T05:31:56Z",
      "processingAttempts": 123,
      "nextRetryAt": "2023-11-07T05:31:56Z",
      "failureCode": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The request could not be completed."
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request could not be completed."
}

Authorizations

Authorization

string

header

required

Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.

Path Parameters

string

required

The unique identifier of the automation to run.

Response

Returns the newly created automation execution record.

History record schema for Leadping API automation run record data exposed in automation and audit views.

string

Unique Leadping identifier for this automation run record.

automationId

null | string

Automation ID connected to this workflow, run, or event.

organizationId

null | string

Organization ID that owns this automation run.

leadId

null | string

Lead ID that triggered this automation run, when the run is lead-based.

triggerType

null | string

Automation trigger type that starts the workflow.

status

string

Current lifecycle status for this automation run record in the Leadping API.

executionMode

string

Execution mode used for automation preview or live workflow processing.

startedAt

string<date-time>

UTC timestamp when processing started for this automation run record.

completedAt

null | string<date-time>

UTC timestamp when processing completed for this automation run record.

processingAttempts

integer<int32>

Number of processing attempts made for this workflow or delivery request.

lastAttemptAt

null | string<date-time>

UTC timestamp when Leadping last attempted to process this automation run.

failureCode

null | string

Machine-readable failure code for troubleshooting this automation run record.

skippedReason

null | string

Human-readable reason explaining why Leadping skipped this automation run.

actions

object[]

Automation actions configured or returned for this workflow.

Show child attributes

API Overview

Endpoints

Runs an automation through its Manual trigger.

Authorizations

Path Parameters

Response