Sms

Cancel a scheduled SMS message for a lead

Cancel a queued SMS message while its status is Scheduled to prevent sending and preserve the event record. Cancellation closes when message delivery begins.

post/sms/{smsEventId}/cancel

Request

  • Base URL: https://api.leadping.ai
  • URL: https://api.leadping.ai/sms/{smsEventId}/cancel
  • Auth: HTTP bearer

Path parameters

smsEventIdstring required

The SMS event identifier.

Response

Returns the SMS response.

isDemoboolean
conversationIdstring

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

leadIdstring

Lead ID associated with the SMS conversation or outreach attempt.

fromPhoneNumberIdstring

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

outboundPhoneNumberIdstring

Phone number ID selected for outbound delivery.

fromPhoneNumberstring nullable

Sender phone number used for this communication.

selectionReason'StickyConversation' | 'LeadAssigned' | 'CampaignOrSource' | 'Preferred' | 'LocalArea' | 'HealthyPool' | 'FallbackDefault' | 'ManualOverride' nullable

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

wasManuallyOverriddenboolean

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

campaignIdstring nullable

Messaging campaign identifier associated with this SMS message.

sourceIdstring nullable

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

textstring

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

status'draft' | 'scheduled' | 'queued' | 'sending' | 'sent' | 'received' | 'delivered' | 'failed' | 'undeliverable' | 'opted_out' | 'blocked_compliance' | 'blocked_billing' | 'blocked_missing_campaign' | 'canceled' nullable

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

statusReasonstring nullable

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

queuedAtstring date-time nullable

UTC timestamp when Leadping queued this SMS message for processing.

scheduledForstring date-time nullable

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

scheduledReasonstring nullable

Reason Leadping scheduled this delivery for a later time.

sendingStartedAtstring date-time nullable

UTC timestamp when Leadping began sending this message.

sentAtstring date-time nullable

UTC timestamp when Leadping sent this message to the provider.

deliveredAtstring date-time nullable

UTC timestamp when the provider confirmed delivery.

receivedAtstring date-time nullable

UTC timestamp when Leadping received this inbound event or message.

failedAtstring date-time nullable

UTC timestamp when processing failed for this SMS message.

undeliverableAtstring date-time nullable

UTC timestamp when the provider marked the message undeliverable.

blockedAtstring date-time nullable

UTC timestamp when Leadping blocked this communication.

nextRetryAtstring date-time nullable

UTC timestamp when Leadping will retry this SMS message.

retryCountinteger

Number of retry attempts already made for this SMS message.

canceledAtstring date-time nullable

UTC timestamp when this delivery or workflow was canceled.

cancelReasonstring nullable

Reason this delivery, run, or request was canceled.

errorCodestring nullable

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

errorMessagestring nullable

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

trafficType'RealLead' | 'Warmup' | 'Test' | 'SystemInternal' | 'FailedAttempt' nullable

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

billableAmountnumber double nullable

Monetary amount billed for this Leadping communication or transaction.

billingStatusstring nullable

Billing state for this communication, charge, or transaction.

complianceActionstring nullable

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

idstring
createdAtstring date-time
modifiedAtstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.