Conversations

Send a message to a lead

Sends an SMS or email message to a lead from the community. The message is queued and delivered through the same pipeline as messages sent from the Further dashboard. Designed for use by embedded messaging surfaces (e.g. the Salesforce app) where an agent composes the message in the caller's UI.

post/api/v1/conversations/leads/{id}/messages/send

Request

  • Base URL: https://api.talkfurther.com
  • URL: https://api.talkfurther.com/api/v1/conversations/leads/{id}/messages/send
  • Auth: one of:
    • API key in header Authorization
    • API key in header Authorization

Path parameters

idinteger required

Request body

message_type'email' | 'sms' required

Channel to send the message on. One of sms or email.

  • email - email
  • sms - sms
textstring required

Message body. Plain text for SMS, HTML or plain text for email.

attachmentstring uri

Optional file attachment (pdf, jpg, jpeg, gif, png).

external_sender_user_idstring

Identifier of the sending agent in the caller's system (e.g. Salesforce user id).

Response

message_idinteger required

Identifier of the message that was created and queued for delivery.

message_type'email' | 'sms' required

Channel the message was sent on (echoed from the request).

  • email - email
  • sms - sms

Changes

No recorded changes to this operation across all 1 revision of this API.