crm/engagements

Create Engagements

Create Engagements in any supported Crm software

post/crm/engagements

Query parameters

remote_databoolean

Set to true to include data from the original Crm software.

Headers

x-connection-tokenstring required

The connection token

Request body

contentstring nullable

The content of the engagement

directionstring nullable

The direction of the engagement. Authorized values are INBOUND or OUTBOUND

subjectstring nullable

The subject of the engagement

start_atstring date-time nullable

The start time of the engagement

end_timestring date-time nullable

The end time of the engagement

typestring nullable required

The type of the engagement. Authorized values are EMAIL, CALL or MEETING

user_idstring nullable

The UUID of the user tied to the engagement

company_idstring nullable

The UUID of the company tied to the engagement

contactsstring[] nullable

The UUIDs of contacts tied to the engagement object

field_mappingsobject nullable

The custom field mappings of the engagement between the remote 3rd party & Panora

Example request

{
  "content": "Meeting call with CTO",
  "direction": "INBOUND",
  "subject": "Technical features planning",
  "start_at": "2024-10-01T12:00:00Z",
  "end_time": "2024-10-01T22:00:00Z",
  "type": "MEETING",
  "user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "contacts": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ],
  "field_mappings": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  }
}

Response

contentstring nullable

The content of the engagement

directionstring nullable

The direction of the engagement. Authorized values are INBOUND or OUTBOUND

subjectstring nullable

The subject of the engagement

start_atstring date-time nullable

The start time of the engagement

end_timestring date-time nullable

The end time of the engagement

typestring nullable required

The type of the engagement. Authorized values are EMAIL, CALL or MEETING

user_idstring nullable

The UUID of the user tied to the engagement

company_idstring nullable

The UUID of the company tied to the engagement

contactsstring[] nullable

The UUIDs of contacts tied to the engagement object

field_mappingsobject nullable

The custom field mappings of the engagement between the remote 3rd party & Panora

idstring nullable

The UUID of the engagement

remote_idstring nullable

The id of the engagement in the context of the Crm 3rd Party

remote_dataobject nullable

The remote data of the engagement in the context of the Crm 3rd Party

created_atstring date-time nullable

The created date of the object

modified_atstring date-time nullable

The modified date of the object

Example response

{
  "content": "Meeting call with CTO",
  "direction": "INBOUND",
  "subject": "Technical features planning",
  "start_at": "2024-10-01T12:00:00Z",
  "end_time": "2024-10-01T22:00:00Z",
  "type": "MEETING",
  "user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "company_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "contacts": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ],
  "field_mappings": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "id_1",
  "remote_data": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}

Changes

Changed in 6 of the 18 revisions of this API.62539

  • be3dc330edf355See the full diff
    • removed the enum value CALL of the request property type

      request-property-enum-value-removed

    • removed the enum value EMAIL of the request property type

      request-property-enum-value-removed

    • removed the enum value INBOUND of the request property direction

      request-property-enum-value-removed

    • removed the enum value MEETING of the request property type

      request-property-enum-value-removed

    • removed the enum value OUTBOUND of the request property direction

      request-property-enum-value-removed

    • removed the CALL enum value from the type response property for the response status 201

      response-property-enum-value-removed

    • removed the EMAIL enum value from the type response property for the response status 201

      response-property-enum-value-removed

    • removed the INBOUND enum value from the direction response property for the response status 201

      response-property-enum-value-removed

    • removed the MEETING enum value from the type response property for the response status 201

      response-property-enum-value-removed

    • removed the OUTBOUND enum value from the direction response property for the response status 201

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ca0fa45ebd05255See the full diff
    • request property direction was restricted to a list of enum values

      request-property-became-enum

    • request property type was restricted to a list of enum values

      request-property-became-enum

    • added the new CALL enum value to the type response property for the response status 201

      response-property-enum-value-added

    • added the new EMAIL enum value to the type response property for the response status 201

      response-property-enum-value-added

    • added the new INBOUND enum value to the direction response property for the response status 201

      response-property-enum-value-added

    • added the new MEETING enum value to the type response property for the response status 201

      response-property-enum-value-added

    • added the new OUTBOUND enum value to the direction response property for the response status 201

      response-property-enum-value-added

    • added the new CALL enum value to the request property type

      request-property-enum-value-added

    • added the new EMAIL enum value to the request property type

      request-property-enum-value-added

    • added the new INBOUND enum value to the request property direction

      request-property-enum-value-added

    • added the new MEETING enum value to the request property type

      request-property-enum-value-added

    • added the new OUTBOUND enum value to the request property direction

      request-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ca213ae36b7f2112See the full diff
    • the response property company_id became nullable for the status 201

      response-property-became-nullable

    • the response property contacts became nullable for the status 201

      response-property-became-nullable

    • the response property content became nullable for the status 201

      response-property-became-nullable

    • the response property created_at became nullable for the status 201

      response-property-became-nullable

    • the response property direction became nullable for the status 201

      response-property-became-nullable

    • the response property end_time became nullable for the status 201

      response-property-became-nullable

    • the response property field_mappings became nullable for the status 201

      response-property-became-nullable

    • the response property id became nullable for the status 201

      response-property-became-nullable

    • the response property modified_at became nullable for the status 201

      response-property-became-nullable

    • the response property remote_data became nullable for the status 201

      response-property-became-nullable

    • the response property remote_id became nullable for the status 201

      response-property-became-nullable

    • the response property start_at became nullable for the status 201

      response-property-became-nullable

    • the response property subject became nullable for the status 201

      response-property-became-nullable

    • the response property type became nullable for the status 201

      response-property-became-nullable

    • the response property user_id became nullable for the status 201

      response-property-became-nullable

    • the response property created_at became optional for the status 201

      response-property-became-optional

    • the response property field_mappings became optional for the status 201

      response-property-became-optional

    • the response property modified_at became optional for the status 201

      response-property-became-optional

    • the response property remote_data became optional for the status 201

      response-property-became-optional

    • the created_at response's property type/format changed from object/ to string/date-time for status 201

      response-property-type-changed

    • the modified_at response's property type/format changed from object/ to string/date-time for status 201

      response-property-type-changed

    • the endpoint scheme security bearer was removed from the API

      api-security-removed

    • the request property company_id became nullable

      request-property-became-nullable

    • the request property contacts became nullable

      request-property-became-nullable

    • the request property content became nullable

      request-property-became-nullable

    • the request property direction became nullable

      request-property-became-nullable

    • the request property end_time became nullable

      request-property-became-nullable

    • the request property field_mappings became nullable

      request-property-became-nullable

    • the request property start_at became nullable

      request-property-became-nullable

    • the request property subject became nullable

      request-property-became-nullable

    • the request property type became nullable

      request-property-became-nullable

    • the request property user_id became nullable

      request-property-became-nullable

    • the request property field_mappings became optional

      request-property-became-optional

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 167edd5346ec135See the full diff
    • the request property company_id became not nullable

      request-property-became-not-nullable

    • the request property contacts became not nullable

      request-property-became-not-nullable

    • the request property content became not nullable

      request-property-became-not-nullable

    • the request property direction became not nullable

      request-property-became-not-nullable

    • the request property end_time became not nullable

      request-property-became-not-nullable

    • the request property field_mappings became not nullable

      request-property-became-not-nullable

    • the request property start_at became not nullable

      request-property-became-not-nullable

    • the request property subject became not nullable

      request-property-became-not-nullable

    • the request property type became not nullable

      request-property-became-not-nullable

    • the request property user_id became not nullable

      request-property-became-not-nullable

    • the request property field_mappings became required

      request-property-became-required

    • the created_at response's property type/format changed from string/date-time to object/ for status 201

      response-property-type-changed

    • the modified_at response's property type/format changed from string/date-time to object/ for status 201

      response-property-type-changed

    • the endpoint scheme security bearer was added to the API

      api-security-added

    • the response property created_at became required for the status 201

      response-property-became-required

    • the response property field_mappings became required for the status 201

      response-property-became-required

    • the response property modified_at became required for the status 201

      response-property-became-required

    • the response property remote_data became required for the status 201

      response-property-became-required

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9d25bd589fe92111See the full diff
    • the response property company_id became nullable for the status 201

      response-property-became-nullable

    • the response property contacts became nullable for the status 201

      response-property-became-nullable

    • the response property content became nullable for the status 201

      response-property-became-nullable

    • the response property created_at became nullable for the status 201

      response-property-became-nullable

    • the response property direction became nullable for the status 201

      response-property-became-nullable

    • the response property end_time became nullable for the status 201

      response-property-became-nullable

    • the response property field_mappings became nullable for the status 201

      response-property-became-nullable

    • the response property id became nullable for the status 201

      response-property-became-nullable

    • the response property modified_at became nullable for the status 201

      response-property-became-nullable

    • the response property remote_data became nullable for the status 201

      response-property-became-nullable

    • the response property remote_id became nullable for the status 201

      response-property-became-nullable

    • the response property start_at became nullable for the status 201

      response-property-became-nullable

    • the response property subject became nullable for the status 201

      response-property-became-nullable

    • the response property type became nullable for the status 201

      response-property-became-nullable

    • the response property user_id became nullable for the status 201

      response-property-became-nullable

    • the response property created_at became optional for the status 201

      response-property-became-optional

    • the response property field_mappings became optional for the status 201

      response-property-became-optional

    • the response property modified_at became optional for the status 201

      response-property-became-optional

    • the response property remote_data became optional for the status 201

      response-property-became-optional

    • the created_at response's property type/format changed from object/ to string/date-time for status 201

      response-property-type-changed

    • the modified_at response's property type/format changed from object/ to string/date-time for status 201

      response-property-type-changed

    • the request property company_id became nullable

      request-property-became-nullable

    • the request property contacts became nullable

      request-property-became-nullable

    • the request property content became nullable

      request-property-became-nullable

    • the request property direction became nullable

      request-property-became-nullable

    • the request property end_time became nullable

      request-property-became-nullable

    • the request property field_mappings became nullable

      request-property-became-nullable

    • the request property start_at became nullable

      request-property-became-nullable

    • the request property subject became nullable

      request-property-became-nullable

    • the request property type became nullable

      request-property-became-nullable

    • the request property user_id became nullable

      request-property-became-nullable

    • the request property field_mappings became optional

      request-property-became-optional

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the endpoint scheme security bearer was removed from the API

      api-security-removed