v1

latestOpenAPI 3.0.3Apache 2.02026-07-1352108391.8 KB

Activities

Create activity

post/crm/activities

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Request body

idstring

The unique identifier of the activity

downstream_idstring nullable

The third-party API ID of original entity

activity_datetimestring nullable

The date and time of the activity

duration_secondsinteger nullable

The duration of the activity in seconds

user_idstring nullable

The user related to the activity

account_idstring nullable

The account related to the activity

contact_idstring nullable

The contact related to the activity

company_idstring nullable

The company related to the activity

opportunity_idstring nullable

The opportunity related to the activity

lead_idstring nullable

The lead related to the activity

owner_idstring nullable

The owner of the activity

campaign_idstring nullable

The campaign related to the activity

case_idstring nullable

The case related to the activity

asset_idstring nullable

The asset related to the activity

contract_idstring nullable

The contract related to the activity

product_idstring nullable

The product related to the activity

solution_idstring nullable

The solution related to the activity

custom_object_idstring nullable

The custom object related to the activity

The type of the activity

titlestring nullable

The title of the activity

descriptionstring nullable

A description of the activity

notestring nullable

An internal note about the activity

locationstring nullable

The location of the activity

all_day_eventboolean nullable

Whether the Activity is an all day event or not

privateboolean nullable

Whether the Activity is private or not

group_eventboolean nullable

Whether the Activity is a group event or not

event_sub_typestring nullable

The sub type of the group event

group_event_typestring nullable

The type of the group event

childboolean nullable

Whether the activity is a child of another activity or not

archivedboolean nullable

Whether the activity is archived or not

deletedboolean nullable

Whether the activity is deleted or not

show_as'free' | 'busy' nullable

doneboolean nullable

Whether the Activity is done or not

start_datetimestring nullable

The start date and time of the activity

end_datetimestring nullable

The end date and time of the activity

duration_minutesinteger nullable

The duration of the activity in minutes

activity_datestring nullable

The date of the activity

end_datestring nullable

The end date of the activity

recurrentboolean

Whether the activity is recurrent or not

reminder_datetimestring nullable

The date and time of the reminder

reminder_setboolean nullable

Whether the reminder is set or not

video_conference_urlstring nullable

The URL of the video conference

video_conference_idstring nullable

The ID of the video conference

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

updated_bystring nullable

The user who last updated the activity

created_bystring nullable

The user who created the activity

updated_atstring nullable

The date and time when the activity was last updated

created_atstring nullable

The date and time when the activity was created

Example request

{
  "id": "12345",
  "downstream_id": "12345",
  "activity_datetime": "2021-05-01T12:00:00.000Z",
  "duration_seconds": 1800,
  "user_id": "12345",
  "account_id": "12345",
  "contact_id": "12345",
  "company_id": "12345",
  "opportunity_id": "12345",
  "lead_id": "12345",
  "owner_id": "12345",
  "campaign_id": "12345",
  "case_id": "12345",
  "asset_id": "12345",
  "contract_id": "12345",
  "product_id": "12345",
  "solution_id": "12345",
  "custom_object_id": "12345",
  "type": "meeting",
  "title": "Meeting",
  "description": "More info about the meeting",
  "note": "An internal note about the meeting",
  "location": "Space",
  "location_address": {
    "id": "123",
    "type": "primary",
    "string": "25 Spring Street, Blackburn, VIC 3130",
    "name": "HQ US",
    "line1": "Main street",
    "line2": "apt #",
    "line3": "Suite #",
    "line4": "delivery instructions",
    "line5": "Attention: Finance Dept",
    "street_number": "25",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94104",
    "country": "US",
    "latitude": "40.759211",
    "longitude": "-73.984638",
    "county": "Santa Clara",
    "contact_name": "Elon Musk",
    "salutation": "Mr",
    "phone_number": "111-111-1111",
    "fax": "122-111-1111",
    "email": "elon@musk.com",
    "website": "https://elonmusk.com",
    "notes": "Address notes or delivery instructions.",
    "row_version": "1-12345"
  },
  "private": true,
  "group_event": true,
  "event_sub_type": "debrief",
  "group_event_type": "Proposed",
  "show_as": "busy",
  "start_datetime": "2021-05-01T12:00:00.000Z",
  "end_datetime": "2021-05-01T12:30:00.000Z",
  "duration_minutes": 30,
  "activity_date": "2021-05-01",
  "end_date": "2021-05-01",
  "reminder_datetime": "2021-05-01T17:00:00.000Z",
  "video_conference_url": "https://meet.example.com/j/88120759396",
  "video_conference_id": "zoom:88120759396",
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "attendees": [
    {
      "id": "12345",
      "name": "Elon Musk",
      "first_name": "Elon",
      "middle_name": "D.",
      "last_name": "Musk",
      "prefix": "Mr.",
      "suffix": "PhD",
      "email_address": "elon@musk.com",
      "is_organizer": true,
      "status": "accepted",
      "user_id": "12345",
      "contact_id": "12345",
      "updated_at": "2017-08-12T20:43:21.291Z",
      "created_at": "2017-08-12T20:43:21.291Z"
    }
  ],
  "updated_by": "12345",
  "created_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

Activity created

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "activities",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}