Send an SMS

post

https://app.lendapi.com/api/v1/app/{app_id}/agent/send-sms/

Sends a text from one of your active SMS templates to the applicant right away. The recipient is always the applicant: the first usable number in the application's phone, mobile or cell_phone, else the customer profile's mobile (10-digit US numbers get +1). The template's own recipient list is not used. custom_body replaces the rendered template text (blank is ignored). Not restricted to live keys.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

400Most common: No phone number found for this applicant. Also body validation errors, e.g. {"template_id": ["This field is required."]}.

401The Bearer key is not an active API key. The response has an empty body (no JSON is returned; the example shows null to stand for that).

404SMS template not found or inactive when template_id is not an active SMS template of yours; Invalid application ID when no application has this app_id.

429Rate limit exceeded: more than 300 requests in a rolling 60-second window for the tenant.

500The SMS could not be sent (Failed to send SMS).