Skip to main content
GET
SMS endpoints are dashboard endpoints. They use the signed-in app session, not X-NearIQ-Key. SMS actions require a Growth plan or higher, available monthly SMS allowance, and proper customer consent before sending messages.
Only message customers who have given consent. Keep opt-out handling available in every workflow that collects SMS contacts.

GET /api/sms

Returns SMS configuration status and the active business SMS number.
To search available numbers, use action=search.

POST /api/sms

Runs one SMS action: provision a number, send a review request, or release the active number.

Provision a number

Send a review request

Release a number

Consent contacts are managed through dashboard business endpoints. SMS consent rows track phone number, consent source, consent timestamp, and opt-out state so review requests, reminders, and conversations can respect customer preferences.

Errors