crm
event
post/crm/{connection_id}/event

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/crm/{connection_id}/event
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring

Unique identifier for this event object

created_atstring date-time

The date that this event object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this event object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

type'NOTE' | 'EMAIL' | 'TASK' | 'MEETING' | 'CALL' | 'MARKETING_EMAIL' | 'FORM' | 'PAGE_VIEW'

The type of event

deal_idsstring[]

An array of deal IDs associated with this event

company_idsstring[]

An array of company IDs associated with this event

contact_idsstring[]

An array of contact IDs associated with this event

lead_idsstring[]
user_idstring

(reference to HrisEmployee)

rawobject

The raw data returned by the integration for this event.

Response

Successful

idstring

Unique identifier for this event object

created_atstring date-time

The date that this event object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this event object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

type'NOTE' | 'EMAIL' | 'TASK' | 'MEETING' | 'CALL' | 'MARKETING_EMAIL' | 'FORM' | 'PAGE_VIEW'

The type of event

deal_idsstring[]

An array of deal IDs associated with this event

company_idsstring[]

An array of company IDs associated with this event

contact_idsstring[]

An array of contact IDs associated with this event

lead_idsstring[]
user_idstring

(reference to HrisEmployee)

rawobject

The raw data returned by the integration for this event.

Changes

    • info

      added the new optional request property

    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status