Skip to main content
POST
Select conversation sender number

Path Parameters

conversationId
string
required

The conversation identifier.

Body

The outgoing number selection request payload for the operation.

Request schema for the Leadping API outgoing number selection request, including the fields clients can send.

conversationId
string | null

Conversation ID that links this outgoing number selection request to the Leadping inbox thread.

leadId
string | null

Lead ID used to choose the best outgoing sender number.

recipientPhoneNumber
string | null

Recipient phone number that receives the outbound message or call.

channel
enum<string> | null

Defines the supported Outgoing Number Channel values.

Available options:
sms,
call
campaignId
string | null

Messaging campaign identifier associated with this outgoing number selection request.

sourceId
string | null

Lead source ID used to choose the best outgoing sender number.

teamId
string | null

Organization ID used to choose the best outgoing sender number.

Response

Returns the outgoing number selection response.

Response schema for the Leadping API outgoing number selection response returned to authenticated clients.

canSend
boolean

Indicates whether Leadping can send outbound messages using this outgoing number selection response.

setupMessage
string | null

Human-readable setup guidance shown for this outgoing number selection response.

phoneNumberId
string | null

Leadping phone number ID connected to this outgoing number selection response.

number
string | null

E.164 phone number exposed by this outgoing number selection response.

displayNumber
string | null

Human-readable phone number shown in Leadping UI and API responses.

healthStatus
enum<string> | null

Defines the supported SMS readiness health assessments.

Available options:
Not Evaluated,
Evaluating,
Healthy,
Needs Attention,
Blocked
healthLabel
string | null

Short label describing the health state for display in dashboards.

healthWarning
string | null

Warning text that explains a potential health or readiness issue.

selectionReason
enum<string> | null

Defines the supported Outgoing Number Selection Reason values.

Available options:
StickyConversation,
LeadAssigned,
CampaignOrSource,
Preferred,
LocalArea,
HealthyPool,
FallbackDefault,
ManualOverride
reasonLabel
string | null

Human-readable label for the reason code on this outgoing number selection response.

wasManuallyOverridden
boolean

Indicates whether a user manually overrode Leadping's automatic number selection for this outgoing number selection response.

campaignId
string | null

Messaging campaign identifier associated with this outgoing number selection response.

sourceId
string | null

Lead source ID considered when Leadping selected the outgoing phone number.

eligibleNumbers
object[]

Phone numbers that are eligible to send the requested outbound message or call.