Replace engagement contacts | AskElephant

import requests
url = "https://app.askelephant.ai/api/v2/engagements/engagement_id/contacts"
payload = { "contact_ids": ["cnt_01H8Z5X9Y2Q7W3E4R5T6U7I8O9"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.json())

{
  "object": "engagement",
  "id": "ngmt_01H8Z5X9Y2Q7W3E4R5T6U7I8O9",
  "title": "Quarterly Business Review",
  "engagement_type": "MEETING",
  "processing_status": "COMPLETED",
  "created_at": "2024-01-10T08:00:00Z",
  "updated_at": "2024-01-15T11:00:00Z",
  "description": "Review meeting with key stakeholders to discuss quarterly performance and next steps.",
  "data_source": "salesforce",
  "is_internal": false,
  "engagement_at": "2024-01-15T09:30:00Z",
  "start_at": "2024-01-15T09:30:00Z",
  "end_at": "2024-01-15T10:30:00Z",
  "duration_seconds": 3600,
  "meeting_url": "https://meetings.askelephant.ai/meeting/123456789",
  "owner_user_id": "usr_01H8Z5X9Y2Q7W3E4R5T6U7I8O9",
  "host_user_id": "usr_01H8Z5X9Y2Q7W3E4R5T6U7I8O8",
  "transcript": "Welcome everyone to the quarterly business review. Today we will cover sales performance, marketing initiatives, and product updates...",
  "media_url": "https://media.askelephant.ai/recordings/ngmt_01H8Z5X9Y2Q7W3E4R5T6U7I8O9.mp4?token=abcdef123456",
  "companies": [
    {
      "object": "engagement_company",
      "id": "cmp_01H8Z5X9Y2Q7W3E4R5T6U7I8O9",
      "name": "Acme Corporation",
      "domains": [
        "acme.com"
      ],
      "crm_association": {
        "object_type": "account",
        "crm_object_id": "0015g00000XyzAbc",
        "source": "salesforce"
      }
    }
  ],
  "contacts": [
    {
      "object": "contact",
      "id": "cnt_01HQY3JMS2QAXJGX6X7CH7CM6X",
      "created_at": "2023-12-01T12:00:00Z",
      "updated_at": "2024-01-10T15:45:00Z",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "description": "Primary customer contact for analytical projects.",
      "company": {
        "id": "cmp_01H8Z5X9Y2Q7W3E4R5T6U7I8O9",
        "object": "engagement_company"
      },
      "emails": [
        {
          "email": "ada.lovelace@acme.com",
          "is_primary": true
        }
      ],
      "phone_numbers": [
        {
          "phone_number": "+1-555-0100",
          "is_primary": true
        }
      ],
      "crm_association": {
        "object_type": "contact",
        "crm_object_id": "0035g00000XyzAbc",
        "source": "salesforce"
      },
      "time_zone": "America/Los_Angeles"
    }
  ],
  "owner": {
    "object": "user",
    "id": "usr_01H8Z5X9Y2Q7W3E4R5T6U7I8O9",
    "role": "OWNER",
    "created_at": "2022-05-20T08:30:00Z",
    "updated_at": "2024-01-14T16:00:00Z",
    "first_name": "John",
    "last_name": "Doe",
    "job_title": "Sales Manager",
    "emails": [
      {
        "email": "john.doe@acme.com",
        "is_primary": true
      }
    ],
    "time_zone": "America/New_York",
    "last_activity_at": "2024-01-15T09:00:00Z"
  },
  "action_items": [
    {
      "object": "engagement_action_item",
      "id": "act_01H8Z5X9Y2Q7W3E4R5T6U7I8O9",
      "title": "Prepare Q2 Sales Forecast",
      "description": "Compile and present the sales forecast for Q2 based on current pipeline.",
      "created_at": "2024-01-15T10:00:00Z",
      "updated_at": "2024-01-15T10:15:00Z",
      "due_on": "2024-02-01",
      "assigned_to_user_id": "usr_01H8Z5X9Y2Q7W3E4R5T6U7I8O9",
      "assigned_to_user_name": "John Doe",
      "assigned_to_user_email": "john.doe@acme.com"
    }
  ],
  "signals": [
    {
      "object": "engagement_signal",
      "id": "sig_01H8Z5X9Y2Q7W3E4R5T6U7I8O9",
      "annotation_definition_id": "ann_01H8Z5X9Y2Q7W3E4R5T6U7I8O9",
      "name": "Positive Sentiment",
      "data_type": "boolean",
      "description": "Indicates positive sentiment detected in the conversation."
    }
  ],
  "tags": [
    {
      "object": "tag",
      "id": "tag_01H8Z5X9Y2Q7W3E4R5T6U7I8O9",
      "name": "Q1 Review",
      "created_at": "2023-12-15T09:00:00Z",
      "updated_at": "2024-01-10T12:00:00Z",
      "hex_color": "#1E90FF",
      "description": "Tag for all Q1 review meetings.",
      "auto_tagging_enabled": false
    }
  ]
}

Replaces the full set of non-calendar-resource contact participants linked to an engagement. Send an empty contact_ids array to clear all managed contacts. Existing calendar-resource participants are preserved. Requires the engagements:write scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

engagement_idstringRequired

Request

This endpoint expects an object.

contact_idslist of stringsRequired

Response headers

X-Api-Versionstring

Response

Updated engagement response.

objectenum

Allowed values:

idstringformat: "^ngmt_[A-Za-z0-9]+$"

titlestring

engagement_typeenum

processing_statusenum

Allowed values:

created_atdatetime

updated_atdatetime

descriptionstring

data_sourcestring

is_internalboolean

engagement_atdatetime

start_atdatetime

end_atdatetime

duration_secondsinteger

meeting_urlstringformat: "uri"

owner_user_idstringformat: "^usr_[A-Za-z0-9]+$"

host_user_idstringformat: "^usr_[A-Za-z0-9]+$"

transcriptstring or null

Full text transcript of the engagement. Only included when expand contains transcript.

media_urlstring or nullformat: "uri"

Temporary signed URL for downloading the engagement recording media. Only included when expand contains media_url. The URL expires after a short period.

companieslist of objects

Companies associated with this engagement. Only included when expand contains companies.

contactslist of objects

Contact participants associated with this engagement. Only included when expand contains contacts.

ownerobject or null

Workspace user who owns this engagement. Only included when expand contains owner.

action_itemslist of objects

Action items created from this engagement. Only included when expand contains action_items.

signalslist of objects

Signals (annotations) extracted from this engagement. Only included when expand contains signals.

tagslist of objects

Tags applied to this engagement. Only included when expand contains tags.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error