Replace engagement tags | AskElephant

curl -X PUT https://app.askelephant.ai/api/v2/engagements/engagement_id/tags \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "tag_ids": [
    "tag_9f8b7c6d5e"
  ]
}'

{
  "object": "engagement",
  "id": "ngmt_4a7b9c8d2e",
  "title": "Quarterly Business Review",
  "engagement_type": "MEETING",
  "processing_status": "COMPLETED",
  "is_private": true,
  "created_at": "2024-01-10T14:00:00Z",
  "updated_at": "2024-01-15T11:00:00Z",
  "description": "Discussion on Q1 performance and upcoming initiatives.",
  "data_source": "zoom",
  "is_internal": false,
  "engagement_at": "2024-01-15T09:30:00Z",
  "start_at": "2024-01-15T09:30:00Z",
  "end_at": "2024-01-15T10:15:00Z",
  "duration_seconds": 2700,
  "meeting_url": "https://zoom.us/j/123456789",
  "external_url": "https://crm.example.com/call/56789",
  "crm_association": {
    "object_type": "deal",
    "crm_object_id": "deal_12345",
    "source": "salesforce"
  },
  "owner_user_id": "usr_7f6e5d4c3b",
  "host_user_id": "usr_1a2b3c4d5e",
  "transcript": "Welcome everyone to the Q1 review. Let's start with sales numbers...",
  "media_url": "https://media.askelephant.ai/recordings/ngmt_4a7b9c8d2e.mp3?token=abc123",
  "companies": [
    {
      "object": "engagement_company",
      "id": "cmp_8e7d6c5b4a",
      "name": "Acme Corporation",
      "domains": [
        "acme.com"
      ],
      "crm_association": {
        "object_type": "account",
        "crm_object_id": "acc_98765",
        "source": "hubspot"
      }
    }
  ],
  "contacts": [
    {
      "object": "contact",
      "id": "cnt_01HQY3JMS2QAXJGX6X7CH7CM6X",
      "created_at": "2026-03-01T12:00:00Z",
      "updated_at": "2026-03-04T18:25:00Z",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "description": "Primary customer contact for analytical projects.",
      "company": {
        "id": "cmp_8e7d6c5b4a",
        "object": "engagement_company"
      },
      "emails": [
        {
          "email": "ada@analytical.engine",
          "is_primary": true
        }
      ],
      "phone_numbers": [
        {
          "phone_number": "+1-555-0100",
          "is_primary": true
        }
      ],
      "crm_association": {
        "object_type": "contact",
        "crm_object_id": "cnt_54321",
        "source": "salesforce"
      },
      "time_zone": "America/Los_Angeles"
    }
  ],
  "owner": {
    "object": "user",
    "id": "usr_7f6e5d4c3b",
    "role": "OWNER",
    "created_at": "2023-06-01T08:00:00Z",
    "updated_at": "2024-01-10T12:00:00Z",
    "first_name": "John",
    "last_name": "Doe",
    "job_title": "Account Manager",
    "emails": [
      {
        "email": "john.doe@askelephant.ai",
        "is_primary": true
      }
    ],
    "time_zone": "America/New_York",
    "last_activity_at": "2024-01-15T09:00:00Z"
  },
  "action_items": [
    {
      "object": "engagement_action_item",
      "id": "ai_1234567890",
      "title": "Follow up with Acme on contract renewal",
      "description": "Send updated contract proposal by end of next week.",
      "created_at": "2024-01-15T10:00:00Z",
      "updated_at": "2024-01-15T10:05:00Z",
      "due_on": "2024-01-22",
      "assigned_to_user_id": "usr_7f6e5d4c3b",
      "assigned_to_user_name": "John Doe",
      "assigned_to_user_email": "john.doe@askelephant.ai"
    }
  ],
  "signals": [
    {
      "object": "engagement_signal",
      "id": "sig_987654321",
      "annotation_definition_id": "ann_def_001",
      "name": "Positive Sentiment",
      "data_type": "boolean",
      "description": "Indicates positive sentiment detected in the conversation."
    }
  ],
  "tags": [
    {
      "object": "tag",
      "id": "tag_9f8b7c6d5e",
      "name": "Q1 Review",
      "created_at": "2023-12-01T09:00:00Z",
      "updated_at": "2024-01-10T09:00:00Z",
      "hex_color": "#1E90FF",
      "description": "Tags for quarterly business review meetings.",
      "auto_tagging_enabled": false
    }
  ]
}

Replaces the full set of tags applied to an engagement. Send an empty tag_ids array to clear all tags. Requires the engagements:write scope. Updating a private engagement also requires engagements:private:write. When the credential can also read the updated engagement, the response returns the engagement payload. Otherwise the update succeeds with 204 No Content.

Replaces the full set of tags applied to an engagement. Send an empty `tag_ids` array to clear all tags. Requires the `engagements:write` scope. Updating a private engagement also requires `engagements:private:write`. When the credential can also read the updated engagement, the response returns the engagement payload. Otherwise the update succeeds with `204 No Content`.

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.

tag_idslist of stringsRequired

Response headers

X-Api-Versionstring

Response

Updated engagement response.

objectenum

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

titlestring

engagement_typeenum

processing_statusenum

is_privateboolean

Indicates whether the engagement is marked private in AskElephant.

created_atdatetime

updated_atdatetime

descriptionstring

data_sourcestring

is_internalboolean

engagement_atdatetime

start_atdatetime

end_atdatetime

duration_secondsinteger

meeting_urlstringformat: "uri"

external_urlstring

URL linking back to this engagement in the originating external system (e.g. a dialer’s call detail page). Accepts https://, http://, and custom app deep-link schemes such as wavv://call/123. Present only when the engagement was created with an external_url value.

crm_associationobject

CRM record linked to this engagement. Present when the engagement has been matched to a CRM record via integration or API.

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