SUsurense
Activity Records

Create an activity (legacy path)

post/activities_v2

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/activities_v2
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token

Request body

typeIdstring required

ID of the activity type (must exist in the caller's tenant)

employerIdstring

Employer to log the activity against. Takes precedence over all other parent IDs; requires the employers:write permission.

customerIdstring

Customer to log the activity against. Used only when employerId, leadId and workflowId are null; requires the customers:update permission.

leadIdstring

Lead to log the activity against. Used only when employerId is null; requires the leads:update permission. The lead's customer is linked too.

workflowIdstring

Workflow to log the activity against. Used only when employerId and leadId are null; requires the workflows:update permission.

meetingIdstring

Meeting to log the activity against. Used only when all other parent IDs are null; requires the meetings:update permission.

htmlContentstring required

Activity content as HTML. Sanitized on save: formatting, blocks, styles, images, links and tables are kept, other markup is removed. Must not be blank.

Example request

{
  "typeId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
  "employerId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "customerId": "b2e4c6d8-1a3b-4c5d-8e7f-9a0b1c2d3e4f",
  "leadId": "0d9e8f7a-6b5c-4d3e-8f2a-1b0c9d8e7f6a",
  "workflowId": "4e5f6a7b-8c9d-4e0f-a1b2-c3d4e5f6a7b8",
  "meetingId": "7b8c9d0e-1f2a-4b3c-9d4e-5f6a7b8c9d0e",
  "htmlContent": "<p>Spoke with the customer about renewing the car insurance policy.</p>",
  "mentions": [
    {
      "type": "user",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "label": "John Doe",
      "order": 0
    }
  ]
}

Response

OK

tenantIdstring uuid
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid

Activity record ID

typeIdstring uuid

ID of the activity type

employerIdstring uuid

Employer the activity is logged against, if any

customerIdstring uuid

Customer the activity is linked to, if any (also set for lead, workflow and meeting activities that relate to a customer)

leadIdstring uuid

Lead the activity is linked to, if any

workflowIdstring uuid

Workflow the activity is logged against, if any

meetingIdstring uuid

Meeting the activity is logged against, if any

activityDatestring date-time

When the activity was logged (ISO-8601, UTC)

htmlContentstring

Sanitized HTML content of the activity

lastEditedAtstring date-time

When the content was last edited (ISO-8601, UTC); null if never edited

lastEditedBystring uuid

ID of the user who last edited the content; null if never edited

Example response

{
  "id": "3c8a1f2e-5d4b-4a9c-b7e6-1f2a3b4c5d6e",
  "typeId": "6f1c2a7e-3b4d-4e8f-9a01-2c3d4e5f6a7b",
  "employerId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "customerId": "b2e4c6d8-1a3b-4c5d-8e7f-9a0b1c2d3e4f",
  "leadId": "0d9e8f7a-6b5c-4d3e-8f2a-1b0c9d8e7f6a",
  "workflowId": "4e5f6a7b-8c9d-4e0f-a1b2-c3d4e5f6a7b8",
  "meetingId": "7b8c9d0e-1f2a-4b3c-9d4e-5f6a7b8c9d0e",
  "activityDate": "2026-03-15T09:30:00Z",
  "htmlContent": "<p>Spoke with the customer about renewing the car insurance policy.</p>",
  "lastEditedAt": "2026-03-16T14:05:00Z",
  "lastEditedBy": "5d6e7f8a-9b0c-4d1e-a2f3-4a5b6c7d8e9f"
}

Changes

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