customers

Send information about the communication by type of canal.

post/v0/contacts/{contact_id}/events

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v0/contacts/{contact_id}/events
  • Auth: OpenID Connect (https://auth.clubmed.com/.well-known/openid-configuration, scopes: openid, email, profile, clubmed)

Path parameters

contact_idstring required

Contact id

Example:123456

Headers

x-api-keystring required

Api_key provided by ClubMed API team

authorizationstring required

Optional Access Token (bearer)

Example:Bearer aaaa.vbbbB.bbbb

Access Token (bearer)

Request body

status'SUCCESS' | 'ABORTED' | 'CLOSED' | 'TRANSFERED' | 'TIMED_OUT' | 'NO_STAFF' | 'END_MASTER_CALL' required

call status

startstring date required

event start time

endstring date required

event end time

way'INBOUND' | 'OUTBOUND' required
agent_idstring required

Agent id

agency_idstring

Agency id

team_codestring required

CCM Code

language_code'fr' | 'nl' | 'de' | 'en' | 'he' | 'it' | 'pt' | 'es' | 'tr' | 'ru' | 'uk' | 'zh' | 'id' | 'ja' | 'ko' | 'vn' | 'ro' | 'pl' | 'et' | 'lv' | 'se' | 'th' | 'gr' | 'ma' | 'tu' | 'sk'

Customer language code (lowercase)

channel'WHATSAPP' | 'PHONE' required

Type of incoming communication used

master_idstring

original contact id

phone_pathPHONEPATHVALUES[]

Customer phone path

Example request

{
  "status": "SUCCESS",
  "start": "2020-12-31T23:55:46.000Z",
  "end": "2020-12-31T23:58:46.000Z",
  "agent_id": "cme412",
  "agency_id": "OPERA",
  "team_code": "C_TEMPE_40_SCTSWS_Ethan BLUM_BLUMTH_SA",
  "language_code": "fr",
  "channel": "WHATSAPP",
  "master_id": "123456",
  "motive": {
    "id": "123456",
    "sub_id": "123456"
  },
  "phone_path": [
    "NEW_BOOKING"
  ],
  "tags": [
    {
      "tag": "CALL_START",
      "values": [
        "promo_message"
      ],
      "event_time": "2026-12-31T23:55:46.000Z"
    }
  ],
  "optins": [
    {
      "channel": "EMAIL",
      "optin": true,
      "optin_partners": true
    }
  ],
  "prioritization": {
    "start_score": 233,
    "end_score": 233
  }
}

Response

no_content

Changes

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