Skip to main content
POST
Cancel a scheduled SMS message for a lead

Path Parameters

smsEventId
string
required

The sms event identifier.

Response

Returns the sms response.

Response schema for the Leadping API SMS message returned to authenticated clients.

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
string | null

Sender phone number used for this communication.

selectionReason
enum<string> | null

Defines the supported Outgoing Number Selection Reason values.

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
string | null

Messaging campaign identifier associated with this SMS message.

sourceId
string | null

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.

status
enum<string> | null

Defines the supported SMS Message Status values.

Available options:
draft,
scheduled,
queued,
sending,
sent,
received,
delivered,
failed,
undeliverable,
opted_out,
blocked_compliance,
blocked_billing,
blocked_missing_campaign,
canceled
statusReason
string | null

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

queuedAt
string<date-time> | null

UTC timestamp when Leadping queued this SMS message for processing.

scheduledFor
string<date-time> | null

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

scheduledReason
string | null

Reason Leadping scheduled this delivery for a later time.

sendingStartedAt
string<date-time> | null

UTC timestamp when Leadping began sending this message.

sentAt
string<date-time> | null

UTC timestamp when Leadping sent this message to the provider.

deliveredAt
string<date-time> | null

UTC timestamp when the provider confirmed delivery.

receivedAt
string<date-time> | null

UTC timestamp when Leadping received this inbound event or message.

failedAt
string<date-time> | null

UTC timestamp when processing failed for this SMS message.

undeliverableAt
string<date-time> | null

UTC timestamp when the provider marked the message undeliverable.

blockedAt
string<date-time> | null

UTC timestamp when Leadping blocked this communication.

nextRetryAt
string<date-time> | null

UTC timestamp when Leadping will retry this SMS message.

retryCount
string<int32>

Number of retry attempts already made for this SMS message.

Pattern: ^-?(?:0|[1-9]\d*)$
canceledAt
string<date-time> | null

UTC timestamp when this delivery or workflow was canceled.

cancelReason
string | null

Reason this delivery, run, or request was canceled.

errorCode
string | null

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

errorMessage
string | null

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

trafficType
enum<string> | null

Defines the supported SMS Traffic Type values.

Available options:
RealLead,
Warmup,
Test,
SystemInternal,
FailedAttempt
billableAmount
string<double> | null

Monetary amount billed for this Leadping communication or transaction.

Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$
billingStatus
string | null

Billing state for this communication, charge, or transaction.

complianceAction
string | null

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

id
string

The unique identifier for the entity.

createdAt
string<date-time>

The date and time when the entity was created.

modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.