Cancel a scheduled SMS message for a lead

curl --request POST \
  --url https://api.leadping.ai/sms/{smsEventId}/cancel \
  --header 'Authorization: Bearer <token>'

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/sms/{smsEventId}/cancel");
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/sms/{smsEventId}/cancel', 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/sms/{smsEventId}/cancel"

	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/sms/{smsEventId}/cancel",
  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;
}

{
  "conversationId": "<string>",
  "leadId": "<string>",
  "fromPhoneNumberId": "<string>",
  "outboundPhoneNumberId": "<string>",
  "fromPhoneNumber": "<string>",
  "selectionReason": "StickyConversation",
  "wasManuallyOverridden": true,
  "campaignId": "<string>",
  "sourceId": "<string>",
  "text": "<string>",
  "media": [
    {
      "url": "<string>",
      "contentType": "<string>",
      "size": 123,
      "sha256": "<string>",
      "fileName": "<string>"
    }
  ],
  "status": "draft",
  "statusReason": "<string>",
  "queuedAt": "2023-11-07T05:31:56Z",
  "scheduledFor": "2023-11-07T05:31:56Z",
  "scheduledReason": "<string>",
  "sendingStartedAt": "2023-11-07T05:31:56Z",
  "sentAt": "2023-11-07T05:31:56Z",
  "deliveredAt": "2023-11-07T05:31:56Z",
  "receivedAt": "2023-11-07T05:31:56Z",
  "failedAt": "2023-11-07T05:31:56Z",
  "undeliverableAt": "2023-11-07T05:31:56Z",
  "blockedAt": "2023-11-07T05:31:56Z",
  "nextRetryAt": "2023-11-07T05:31:56Z",
  "retryCount": 123,
  "canceledAt": "2023-11-07T05:31:56Z",
  "cancelReason": "<string>",
  "errorCode": "<string>",
  "errorMessage": "<string>",
  "trafficType": "RealLead",
  "billableAmount": 123,
  "billingStatus": "<string>",
  "complianceAction": "<string>",
  "consoleEntries": [
    {
      "id": "<string>",
      "stage": "<string>",
      "status": "<string>",
      "message": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z"
    }
  ],
  "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": "Not Found",
  "status": 404,
  "detail": "The request could not be completed."
}

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

POST

sms

{smsEventId}

cancel

Cancel a scheduled SMS message for a lead

curl --request POST \
  --url https://api.leadping.ai/sms/{smsEventId}/cancel \
  --header 'Authorization: Bearer <token>'

using RestSharp;


var options = new RestClientOptions("https://api.leadping.ai/sms/{smsEventId}/cancel");
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/sms/{smsEventId}/cancel', 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/sms/{smsEventId}/cancel"

	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/sms/{smsEventId}/cancel",
  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;
}

{
  "conversationId": "<string>",
  "leadId": "<string>",
  "fromPhoneNumberId": "<string>",
  "outboundPhoneNumberId": "<string>",
  "fromPhoneNumber": "<string>",
  "selectionReason": "StickyConversation",
  "wasManuallyOverridden": true,
  "campaignId": "<string>",
  "sourceId": "<string>",
  "text": "<string>",
  "media": [
    {
      "url": "<string>",
      "contentType": "<string>",
      "size": 123,
      "sha256": "<string>",
      "fileName": "<string>"
    }
  ],
  "status": "draft",
  "statusReason": "<string>",
  "queuedAt": "2023-11-07T05:31:56Z",
  "scheduledFor": "2023-11-07T05:31:56Z",
  "scheduledReason": "<string>",
  "sendingStartedAt": "2023-11-07T05:31:56Z",
  "sentAt": "2023-11-07T05:31:56Z",
  "deliveredAt": "2023-11-07T05:31:56Z",
  "receivedAt": "2023-11-07T05:31:56Z",
  "failedAt": "2023-11-07T05:31:56Z",
  "undeliverableAt": "2023-11-07T05:31:56Z",
  "blockedAt": "2023-11-07T05:31:56Z",
  "nextRetryAt": "2023-11-07T05:31:56Z",
  "retryCount": 123,
  "canceledAt": "2023-11-07T05:31:56Z",
  "cancelReason": "<string>",
  "errorCode": "<string>",
  "errorMessage": "<string>",
  "trafficType": "RealLead",
  "billableAmount": 123,
  "billingStatus": "<string>",
  "complianceAction": "<string>",
  "consoleEntries": [
    {
      "id": "<string>",
      "stage": "<string>",
      "status": "<string>",
      "message": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z"
    }
  ],
  "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": "Not Found",
  "status": 404,
  "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

smsEventId

string

required

The SMS event identifier.

Response

Returns the SMS response.

Describes an SMS or MMS message, including participants, delivery state, scheduling, media, and billing details.

conversationId

string

Conversation ID that links this SMS message to the Leadping inbox thread.

leadId

string

Lead ID associated with the SMS conversation or outreach attempt.

fromPhoneNumberId

string

Sender phone number ID used for this outbound SMS or call.

outboundPhoneNumberId

string

Phone number ID selected for outbound delivery.

fromPhoneNumber

null | string

Sender phone number used for this communication.

selectionReason

null | enum<string>

Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.

Available options:

StickyConversation,

LeadAssigned,

CampaignOrSource,

Preferred,

LocalArea,

HealthyPool,

FallbackDefault,

ManualOverride

wasManuallyOverridden

boolean

Indicates whether a user manually overrode Leadping's automatic number selection for this SMS message.

campaignId

null | string

Messaging campaign identifier associated with this SMS message.

sourceId

null | string

Lead source ID used for attribution and sender selection on this SMS message.

text

string

Body text for the SMS message or communication represented by this SMS message.

media

object[]

Media attached to this message. A non-empty collection identifies an MMS message.

Show child attributes

status

null | enum<string>

Describes the normalized lifecycle of an SMS or MMS message from scheduling through delivery or failure.

Available options:

draft,

scheduled,

queued,

sending,

sent,

received,

delivered,

failed,

undeliverable,

opted_out,

blocked_compliance,

blocked_billing,

blocked_missing_campaign,

canceled

statusReason

null | string

Human-readable reason explaining the current status of this SMS message.

queuedAt

null | string<date-time>

UTC timestamp when Leadping queued this SMS message for processing.

scheduledFor

null | string<date-time>

UTC timestamp when Leadping is scheduled to send this SMS message.

scheduledReason

null | string

Reason Leadping scheduled this delivery for a later time.

sendingStartedAt

null | string<date-time>

UTC timestamp when Leadping began sending this message.

sentAt

null | string<date-time>

UTC timestamp when Leadping sent this message to the provider.

deliveredAt

null | string<date-time>

UTC timestamp when the provider confirmed delivery.

receivedAt

null | string<date-time>

UTC timestamp when Leadping received this inbound event or message.

failedAt

null | string<date-time>

UTC timestamp when processing failed for this SMS message.

undeliverableAt

null | string<date-time>

UTC timestamp when the provider marked the message undeliverable.

blockedAt

null | string<date-time>

UTC timestamp when Leadping blocked this communication.

nextRetryAt

null | string<date-time>

UTC timestamp when Leadping will retry this SMS message.

retryCount

integer<int32>

Number of retry attempts already made for this SMS message.

canceledAt

null | string<date-time>

UTC timestamp when this delivery or workflow was canceled.

cancelReason

null | string

Reason this delivery, run, or request was canceled.

errorCode

null | string

Machine-readable error code returned while processing this SMS message.

errorMessage

null | string

Human-readable error message returned while processing this SMS message.

trafficType

null | enum<string>

Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose.

Available options:

RealLead,

Warmup,

Test,

SystemInternal,

FailedAttempt

billableAmount

null | number<double>

Monetary amount billed for this Leadping communication or transaction.

billingStatus

null | string

Billing state for this communication, charge, or transaction.

complianceAction

null | string

Compliance action applied to this message, lead, or sender.

consoleEntries

object[]

Ordered diagnostic entries recorded while Leadping processed this message.

Show child attributes

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

Cancel a scheduled SMS message for a lead

Authorizations

Path Parameters

Response