POST
/api/public/v1/invoices/{invoiceId}/send-textText an invoice
Texts the customer their pay link at the invoice’s `counterpartyPhone`. It goes out on the company number — the location number chosen in Settings → Communications — or the Pixelbase number while the company has none that can send. Like emailing, only an OPEN invoice can be texted, and a PENDING_CONTRACT invoice is texted on its own once the contract behind it is signed.
Required scope
The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.
invoices:write
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
invoiceId | string | Required | Invoice ID. |
POSTExample request
curl
curl -X POST "https://www.pxb.app/api/public/v1/invoices/{invoiceId}/send-text" \
-H "Authorization: Bearer your_access_token"200Example response
json
{
"message": "Invoice texted to +16025550142.",
"content": {
"invoiceId": "9f1c2f4e-6b3a-4f28-9c11-0a2b3c4d5e6f",
"phone": "+16025550142"
}
}400Example response
json
{
"message": "This invoice has no customer phone number."
}In the console
The same thing done by hand, for anyone comparing the API against the screen they already use.