• Customermates Logo
    CustomermatesDocumentation
  • Einführung
Erste Schritte
  • Quickstart
  • Kernkonzepte
KI verbinden
  • Custom Connector
  • CLI & Editoren
  • Ratenlimits
Integrationen
  • MCP
  • Webhooks
  • OpenAPI 3.1.0
  • N8N
Self-Hosting
  • Get Started
  • Architektur & Sicherheit
App-Leitfaden
  • Dashboard
  • Posteingang
  • Datensätze
  • Profil
  • Unternehmen
  • API-Keys
  • Filter-Syntax
  • Zurück
  1. Einführung
  3. OpenAPI 3.1.0
OverviewAccept a relation requestPOSTBrowse a Sales Navigator listPOSTCalendar ChangedWEBHOOKCalendar Event ChangedWEBHOOKCancel a relation requestPOSTChat DeletedWEBHOOKChat UpdatedWEBHOOKContact CreatedWEBHOOKContact DeletedWEBHOOKContact UpdatedWEBHOOKCreate a contactPOSTCreate a dealPOSTCreate a servicePOSTCreate a taskPOSTCreate a webhook subscriptionPOSTCreate an organizationPOSTCreate many contactsPOSTCreate many dealsPOSTCreate many organizationsPOSTCreate many servicesPOSTCreate many tasksPOSTDeal CreatedWEBHOOKDeal DeletedWEBHOOKDeal UpdatedWEBHOOKDelete a contactDELETEDelete a dealDELETEDelete a serviceDELETEDelete a taskDELETEDelete a webhook subscriptionDELETEDelete an organizationDELETEDelete many contactsDELETEDelete many dealsDELETEDelete many organizationsDELETEDelete many servicesDELETEDelete many tasksDELETEDiscard a message draftDELETEEmail DeletedWEBHOOKEmail ReceivedWEBHOOKGet a calendar by IDGETGet a calendar event by IDGETGet a contact by IDGETGet a deal by IDGETGet a messaging thread by IDGETGet a service by IDGETGet a social profilePOSTGet a task by IDGETGet a webhook subscriptionGETGet activitiesPOSTGet an organization by IDGETGet calendar eventsPOSTGet calendarsPOSTGet contactsPOSTGet contacts configurationGETGet dealsPOSTGet deals configurationGETGet messaging threadsPOSTGet organizationsPOSTGet organizations configurationGETGet own user profileGETGet servicesPOSTGet services configurationGETGet tasksPOSTGet tasks configurationGETGet usersPOSTList or fetch social postsPOSTList own connected accountsGETList post comments or reactionsPOSTList received relation requestsPOSTList Sales Navigator listsPOSTList Sales Navigator search parametersPOSTMessage DeletedWEBHOOKMessage ReactionWEBHOOKMessage ReceivedWEBHOOKMessage UpdatedWEBHOOKOrganization CreatedWEBHOOKOrganization DeletedWEBHOOKOrganization UpdatedWEBHOOKRelation CreatedWEBHOOKRun a Sales Navigator search from a URLPOSTSave a lead or account to a Sales Navigator listPOSTSave a message draftPOSTSearch Sales Navigator companies (accounts)POSTSearch Sales Navigator people (leads)POSTSend a chat messagePOSTSend a relation requestPOSTSend an emailPOSTService CreatedWEBHOOKService DeletedWEBHOOKService UpdatedWEBHOOKStart a chatPOSTTask CreatedWEBHOOKTask DeletedWEBHOOKTask UpdatedWEBHOOKUpdate a contactPUTUpdate a dealPUTUpdate a servicePUTUpdate a taskPUTUpdate an organizationPUTUpdate many contactsPUTUpdate many dealsPUTUpdate many organizationsPUTUpdate many servicesPUTUpdate many tasksPUT

Start a chat

Starts a new chat thread (LinkedIn, WhatsApp, etc.) with one or more attendees from a connected account and sends the first message. This delivers a real message as a side effect.

POST
/v1/messaging/start-chat

Authorization

apiKeyAuth
x-api-key<token>

API key authentication. Create an API key in your user profile and include it in the x-api-key header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

connectedAccountId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
attendeeIdentifiers*array<>
Items1 <= items
text*string
Lengthlength <= 20000
chatName?string

Optional display name for the new chat (group chats)

Lengthlength <= 998
linkedinProduct?string

LinkedIn only: which product to send from. classic (default), sales_navigator or recruiter start the chat from that product's inbox; the two latter send an InMail and require inmailSubject (recruiter also inmailSignature)

Value in"classic" | "sales_navigator" | "recruiter"
inmail?boolean

LinkedIn classic only: send as InMail to message people outside your network (uses InMail credit)

inmailSubject?string

Subject line of the InMail. Required for sales_navigator and recruiter

Lengthlength <= 998
inmailSignature?string

Sender signature. Required for recruiter

Lengthlength <= 998
attachments?array<>
Itemsitems <= 20

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://customermates.com/api/v1/messaging/start-chat" \  -H "Content-Type: application/json" \  -d '{    "connectedAccountId": "ac03972a-5ca5-43c5-b96f-c519ac843b7a",    "attendeeIdentifiers": [      "string"    ],    "text": "string"  }'
{
  "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e"
}
"string"
"string"
"string"
"string"