Send a text

POST /v1/texts sends one text to one contact from your organization's texting number. Use it for texts your website sends one person at a time: "Your quote is ready", "See you at the studio tomorrow at 3". With more than one number, it goes from the number the contact is on, or your default. The text is kept in the contact's conversation in your Inbox, and their reply arrives there too.

Your organization needs its own texting number first. You request it under Settings → Messaging. See Text messaging.

Text a contactCopy Anchor Link

The contact is saved first, the same way as PUT /v1/contacts, and the text goes to the first phone number you send.

curl -X POST https://api.lahuta.org/v1/texts \
  -H "X-Api-Key: $LAHUTA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "commission-quote:2291",
    "contact": {
      "kind": "person",
      "firstName": "Hannah",
      "lastName": "Lindqvist",
      "phones": [{ "label": "Mobile", "value": "+15035550131" }]
    },
    "body": "Hi Hannah, the quote for your eight dinner plates is ready. Check your email, or reply here with any questions."
  }'

{
  "messageId": "0197b36b-2a14-7f31-9c07-5e8d1b4a6f20",
  "conversationId": "0197a9d4-0b77-7c52-8e19-3f6a2d9c1b84",
  "contactId": "0197b36a-4e11-7a53-9f02-6b1c8e4d2a37",
  "opened": true
}

Things to know:

• It's sent as written. There are no personal values, so put the person's name in yourself. A body with a {{lahuta:…}} value in it is refused.
• It carries your organization's name. It starts with your organization's name and ends with "Reply STOP to opt out", unless your message already says how to stop. Both count toward the 1,600 characters a text can have, which is why body stops at 1,400.
• Its links are tracked. Each link goes out as a short link, like lahuta.org/l/x7Kq2mPa, that opens the page you wrote. A workflow can wait for the contact to tap it.
• It's kept in your Inbox. The text shows in the contact's conversation, sent by your organization. When they reply, your team sees it there and can answer. conversationId is that conversation.
• The number has to be in the call. A contact who already has a phone number in Lahuta still needs one in contact.phones.
• It's for one person at a time. To text a list, use a text campaign.
• It doesn't need marketing consent. A text sent this way is treated like a reply from your inbox, about something the person asked for. Campaigns and workflow texts need recorded consent.

ErrorsCopy Anchor Link

When a text is refused, nothing is sent and the contact isn't saved.

See Texts in the API reference for every field.

RelatedCopy Anchor Link