Digital Activities Management

Create a Digital Activity by email

Creates a Digital Activity record by identifying the Contact (and therefore Account) using an email address. The endpoint accepts all standard Digital Activity fields plus an email field to automatically determine contact_id and account_id.

post/api/digital-activities

Request

  • Base URL: https://api.reallysimplesystems.com
  • URL: https://api.reallysimplesystems.com/api/digital-activities
  • Auth: HTTP bearer

Request body

emailstring required

The email address of the contact. Used to identify both the Contact and Account for the Digital Activity.

typestring required

The type of Digital Activity (e.g., "FormWasSubmitted", "WebsiteHit", "EmailLinkWasClicked").

scorenumber

The score value for this activity.

occurred_atstring

The date and time when the activity occurred (format: Y-m-d H:i:s).

furtherInfostring

JSON string containing additional information about the activity (e.g., form fields, UTM parameters).

Example request

{
  "email": "john.doe@example.com",
  "type": "FormWasSubmitted",
  "score": 10,
  "occurred_at": "2025-01-20 14:30:00",
  "furtherInfo": "{\"FormId\":123,\"FormName\":\"Contact Form\",\"FormFields\":[{\"Label\":\"Name\",\"Value\":\"John\"}]}"
}

Response

Digital Activity created successfully.

statusstring
messagestring

Example response

{
  "status": "success",
  "message": "Digital Activity created successfully.",
  "data": {
    "metadata": {
      "url": "http://api.example.com/api/digitalactivities/123",
      "list_url": "http://api.example.com/api/digitalactivities",
      "parent": null,
      "object_type": "record",
      "record_type": "digitalactivity"
    },
    "record": {
      "id": 123,
      "type": "FormWasSubmitted",
      "score": 10,
      "contact_id": 45,
      "account_id": 12
    }
  }
}

Changes

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