Sign in

v1

latestOpenAPI 3.0.02026-07-26870415.2 KB
contacts

Send a proactive message to a contact

Delivers a new outbound message through the exact channel_node_id chosen for the contact. Supply sender_id when you need to choose the exact workspace sender returned by /v1/workspaces/{id}/senders.

post/v1/contacts/{id}/messages

Path parameters

idstring required

Contact id.

Example:ph77c0dy0mgdpzmqz6tesry8w184002s

Query parameters

workspace_idstring

Optional workspace override. If omitted, Conduit resolves the contact's workspace automatically.

Example:j57demo8f8x7c9v0n2q4r6t8y1u3i5o

Request body

channel_node_idstring required

Exact contact channel node to deliver through.

sender_idstring

Optional workspace sender to use. Required when multiple compatible senders exist and no single default can be chosen.

bodystring

Plain-text message body. Required unless whatsapp_template is provided.

subjectstring

Optional subject for email channel nodes.

Example request

{
  "channel_node_id": "hg77c0dy0mgdpzmqz6tesry8w184002s",
  "sender_id": "whatsapp_number:+14155550999",
  "whatsapp_template": {
    "content_sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "variables": {
      "1": "Alex",
      "2": "May 15 at 3 PM"
    }
  }
}

Response

Contact message accepted

Example response

{
  "data": {
    "id": "yh7t5azsr0zpfpyf67vtce0j6n844y1e",
    "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
    "contact_id": "ph77c0dy0mgdpzmqz6tesry8w184002s",
    "channel_node_id": "hg77c0dy0mgdpzmqz6tesry8w184002s",
    "sender_id": "gmail_account:team@conduit.ai",
    "channel": "email",
    "status": "sent"
  }
}