Create an organization lead follow-up automation

curl --request POST \
  --url https://api.leadping.ai/automations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://api.leadping.ai/automations"

payload = { "name": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


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

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

HttpResponse<String> response = Unirest.post("https://api.leadping.ai/automations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\"\n}")
  .asString();

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

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

package main

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

func main() {

	url := "https://api.leadping.ai/automations"

	payload := strings.NewReader("{\n  \"name\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

{
  "description": "<string>",
  "enabled": true,
  "organizationId": "<string>",
  "createdByUserId": "<string>",
  "scope": "<string>",
  "visibility": "<string>",
  "managementLevel": "<string>",
  "isSystemManaged": true,
  "triggers": [
    {
      "id": "<string>",
      "type": "<string>",
      "displayName": "<string>",
      "isEnabled": true,
      "settings": {}
    }
  ],
  "conditionGroups": [
    {
      "id": "<string>",
      "mode": "<string>",
      "conditions": [
        {
          "id": "<string>",
          "type": "<string>",
          "operator": "<string>",
          "isEnabled": true,
          "settings": {}
        }
      ]
    }
  ],
  "actions": [
    {
      "id": "<string>",
      "type": "<string>",
      "order": 123,
      "isEnabled": true,
      "settings": {}
    }
  ],
  "connections": [
    {
      "id": "<string>",
      "sourceNodeId": "<string>",
      "targetNodeId": "<string>",
      "weight": 123
    }
  ],
  "lastRunAt": "2023-11-07T05:31:56Z",
  "lastRunStatus": "<string>",
  "version": 123,
  "user": {
    "id": "<string>",
    "name": "<string>"
  },
  "organization": {
    "id": "<string>",
    "name": "<string>"
  },
  "name": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

{
  "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

Create an organization lead follow-up automation

curl --request POST \
  --url https://api.leadping.ai/automations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://api.leadping.ai/automations"

payload = { "name": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


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

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

HttpResponse<String> response = Unirest.post("https://api.leadping.ai/automations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\"\n}")
  .asString();

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

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

package main

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

func main() {

	url := "https://api.leadping.ai/automations"

	payload := strings.NewReader("{\n  \"name\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

{
  "description": "<string>",
  "enabled": true,
  "organizationId": "<string>",
  "createdByUserId": "<string>",
  "scope": "<string>",
  "visibility": "<string>",
  "managementLevel": "<string>",
  "isSystemManaged": true,
  "triggers": [
    {
      "id": "<string>",
      "type": "<string>",
      "displayName": "<string>",
      "isEnabled": true,
      "settings": {}
    }
  ],
  "conditionGroups": [
    {
      "id": "<string>",
      "mode": "<string>",
      "conditions": [
        {
          "id": "<string>",
          "type": "<string>",
          "operator": "<string>",
          "isEnabled": true,
          "settings": {}
        }
      ]
    }
  ],
  "actions": [
    {
      "id": "<string>",
      "type": "<string>",
      "order": 123,
      "isEnabled": true,
      "settings": {}
    }
  ],
  "connections": [
    {
      "id": "<string>",
      "sourceNodeId": "<string>",
      "targetNodeId": "<string>",
      "weight": 123
    }
  ],
  "lastRunAt": "2023-11-07T05:31:56Z",
  "lastRunStatus": "<string>",
  "version": 123,
  "user": {
    "id": "<string>",
    "name": "<string>"
  },
  "organization": {
    "id": "<string>",
    "name": "<string>"
  },
  "name": "<string>",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

{
  "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_.

Body

The automation request payload for the operation.

Defines the fields clients can send when working with automation configuration.

name

string

required

Human-readable display name for the resource, subject to the API's maximum name length.

Maximum string length: 255

description

null | string

Human-readable description that explains this automation configuration request to API users.

enabled

null | boolean

Indicates whether this automation configuration request is active and available in the Leadping API.

scope

null | string

Scope that limits where this automation configuration request applies in Leadping.

visibility

null | string

Visibility level that controls who can see this automation configuration request.

triggers

object[]

Automation triggers that can start this workflow.

Show child attributes

conditionGroups

object[]

Grouped automation conditions used to decide whether this workflow should run.

Show child attributes

actions

object[]

Automation actions configured or returned for this workflow.

Show child attributes

connections

object[]

Directed connections between nodes in this automation graph.

Show child attributes

version

integer<int32>

Version number for this automation configuration request schema or saved configuration.

null | string

Stable unique identifier of an existing resource to update; omit it when the API assigns an identifier during creation.

Response

The automation response was created successfully.

Describes automation configuration data returned by Leadping.

description

null | string

Human-readable description that explains this automation configuration response to API users.

enabled

null | boolean

Indicates whether this automation configuration response is active and available in the Leadping API.

organizationId

null | string

Organization ID that owns this automation.

createdByUserId

null | string

User ID of the person who created this automation configuration response.

scope

null | string

Scope that limits where this automation configuration response applies in Leadping.

visibility

null | string

Visibility level that controls who can see this automation configuration response.

managementLevel

null | string

Management level that controls whether Leadping or the organization owns this automation setting.

isSystemManaged

boolean

Indicates whether Leadping manages this automation configuration response automatically instead of a user.

triggers

object[]

Automation triggers that can start this workflow.

Show child attributes

conditionGroups

object[]

Grouped automation conditions used to decide whether this workflow should run.

Show child attributes

actions

object[]

Automation actions configured or returned for this workflow.

Show child attributes

connections

object[]

Directed connections between nodes in this automation graph.

Show child attributes

lastRunAt

null | string<date-time>

UTC timestamp when this automation last ran.

lastRunStatus

null | string

Status from the most recent automation run.

version

integer<int32>

Version number for this automation configuration response schema or saved configuration.

user

object | null

User summary connected to this automation configuration response.

Show child attributes

organization

object | null

Organization summary connected to this automation configuration response.

Show child attributes

name

string

Human-readable display name of the resource.

string

Stable unique identifier of the resource.

createdAt

string<date-time>

UTC timestamp when the resource was created.

modifiedAt

null | string<date-time>

UTC timestamp when the resource was last modified, or null when it has not been updated.

API Overview

Endpoints

Create an organization lead follow-up automation

Authorizations

Body

Response