✈️

Release date: November 27, 2024

Octopus API version: 2.49
Database version: 18.18.1

This release includes internal improvements and bug fixes that enhance the API performance and reliability. These changes do not affect the API's functionality or require any action from end users.


Notes

✈️

Release date: October 30, 2024

Octopus API version: 2.48
Database version: 18.18.1

New features and improvements

  1. Webhook improvements for InteractionLog and QuotaActivity/QuotaRevenue
    • InteractionLog - the "Type" field is now sent expanded with the following sub fields:
      • Key
      • Name
      • Icon
      • BiDirectional
      • External
    • QuotaActivity/QuotaRevenue - the event for "Delete" now includes the proper Milestones from the deleted record.

Bug Fixes

  1. Case read not working for null priority/severity
    When retrieving DisplayValue for Case Severity and Priority, if the current numeric value is invalid or unknown, the DisplayValue will be returned as empty string.

Notes

✈️

Release date: September 25, 2024

Octopus API version: 2.47
Database version: 18.18.1

New features and improvements

  1. AbEntries KeyOnly (Legacy Driver) Webhooks
    Added support for sending KeyOnly events through webhooks when creating, updating and deleting AbEntry.
  2. InteractionLog Full (SQL Driver) Webhooks
    Added support for sending Full events through webhooks when creating, updating and deleting InteractionLog and InteractionLogDefault using SQL Driver.
  3. Cases KeyOnly (Legacy Driver) Webhooks
    Added support for sending KeyOnly events through webhooks when creating, updating and deleting Case and CaseDefault using Legacy Driver.
  4. Cases Full (SQL Driver) Webhooks
    Added support for sending Full events through webhooks when creating, updating and deleting Case and CaseDefault using SQL Driver.

Bug Fixes

  1. Interaction Read not returning null PageKey when total entries is lower than PageSize
    When using pagination in Interaction Read, null page key will be returned when number of records read is lower than page size (same behavior as other Octopus objects).
  2. Not able to set multiple users for SecAccess in AbEntry Create
    When SecAccess default entry for AbEntry is set as public, and user creates AbEntry with multiple users in SecAccess, API will create the entity as requested, instead of ignoring all the users passed.
  3. Inconsistency in Query syntax
    API now verifies query operators and returns error when those are not valid.
  4. Code Snippet Displayed Instead of Values in 'Current Stage Age Gap' Column
    Fix for calculated field Current Stage Age Gap in Opportunity ColumnSetup. When the needed fields for calculation are null, instead of the error with the expression, empty value will be returned.
  5. Appointment - All day event not returned
    Fix retrieving all-day appointments through the Octopus API. In some scenarios, where a date-only value is specified in the criteria for StartDate or EndDate (for example, "EndDate": { "$EQ": "2024-09-06" }), the all-day appointments would not be returned.
  6. Problems downloading EmailDocument content
    Fix for Opportunity creation using SQL Driver when readonly objects like SalesProcessSetup or SalesStageSetup are included in the payload.

Notes

We’ve made significant updates to our Developer Portal, including a refreshed Maximizer API reference that’s designed to make your development experience smoother and more efficient.

What’s New:

  • Ferret API v2 (Beta): The new version of the Ferret API is more consistent and aligned with the Octopus API, making it easier than ever to integrate with the Maximizer APIs. For now, Ferret API v2 offers a limited set of methods for reading entities, helping you get started quickly and efficiently.
  • Extended Octopus API Documentation: We’ve expanded the Octopus API section to fully mirror our Postman collection, ensuring you can access the most comprehensive and up-to-date documentation.
  • Additional Guides: We’ve also added new guides to the portal, such as how to create deep links and much more to help you get the most out of our APIs.

The old version of the portal, including the Ferret API v1 documentation, is still available here: https://developer.maximizer.com/v1.6/docs/getting-started.

You can also switch between versions by selecting the desired version in the left corner right under the logo.

✈️

Release date: August 21, 2024

Octopus API version: 2.46
Database version: 18.18.1

Bug Fixes

  1. Handle invalid characters for headers of BinaryDownload
    Endpoint BinaryDownload is now able to correctly handle invalid characters in file names.
  2. Not able to update partnerKey for AbEntryDefault
    Update of PartnerKey on AbEntryDefault using SQL driver is now handled correctly.

Notes

✈️

Release date: July 24, 2024

Octopus API version: 2.45
Database version: 18.17.0

New features and improvements

  1. Table Udf FieldOptions - Apply same sorting as Legacy
    Reading FieldOption for Table Udf items now follow the same sort/order defined the UI, rather than always ordering by the item description.
  2. KeyField Definition - Add support for all fields
    KeyFieldDefinition layout creation now supports adding any field from a given object (based on the $METADATA definition), except "DisplayValue" (not supported in layouts).
  3. KeyFieldList - Add Target + Fix FieldId mapping
    Added Target field to KeyFieldList object.

Bug Fixes

  1. KeyFieldList - Fail to retrieve SecAccess FieldOptions
    Added support to retrieve FieldOptions for KeyFieldList and KeyFieldDefinition objects.

Notes

✈️

Release date: June 19, 2024

Octopus API version: 2.44
Database version: 18.17.0

New features and improvements

  1. Add support for Key Field List CUD
    Implemented support for Create, Update and Delete (CUD) operations on KeyFieldList object.
  2. Add support for Key Field Definition CUD
    Implemented support for Create, Update and Delete (CUD) operations on KeyFieldDefinition object. The current version supports only EntityType = 2 (Opportunity) and EntityType = 5 (Case).
  3. Add more fields to "group by" support for Tasks
    Added support for group by for following properties of task: AbEntryKey, LeadKey, WithKey
  4. Formula UDFs - Create on demand recalculation process
    Now API supports recalculation of formula udfs on demand. That process will use new scripting library, will run in async way and will allow recalculation of old and new formulas.

Bug Fixes

  1. Appointments - Description is truncated by 6000 characters when updated
    When creating or updating an appointment the description field will be truncated by 8192 (current MaxLength Metadata configuration)

Notes

✈️

Release date: May 22, 2024

Octopus API version: 2.43
Database version: 18.17.0

New features and improvements

  1. Webhooks (BETA) - Implement Webhooks for Appointments
    New events will be generated when an Appointment is created, updated and deleted. This is a beta implementation, all events will have version = 0.1.
    The events will contain only the AppointmentKey. If any detail is needed, consumers will have to perform a /Read call to Octopus API and use the key as filter to get any extra information needed.

Notes

✈️

Release date: April 24, 2024

Octopus API version: 2.42
Database version: 18.15.0

Bug Fixes

  1. Opportunity - Using $SUM with ForecastRevenue field fails
    Added support to $SUM by ActualRevenue, ForecastRevenue and Revenue on Opportunity object.
  2. SecAccess - Add brackets "[ ]" around the Display name in Security Group
    Added brackets around the Display Name in SecAccess object.
  3. Opportunity - group by AbEntryKey doesn't work
    Added support for grouping by AbEntryKey and ContactKey on Opportunity using SQL driver.

Notes

✈️

Release date: March 27, 2024

Octopus API version: 2.41
Database version: 18.15.0

Bug Fixes

  1. Udf: yesNo attribute when adding or updating a Udf is not saved as expected
    Fixed the parsing of the attribute "yesNo" and saving the value properly.
  2. All mandatory fields are not returned in validate command
    Fixed a bug that was preventing mandatory formulas to work properly in very specific scenarios of validating Opportunities. The issue would happen when there is a mix of mandatory formulas that uses Revenue Type as a condition with other mandatory formulas that uses any other field (for example, Categories).

New features and improvements

  1. ImportTemplate: remove forced compatibility for string schema 2.0.
    Import Template creation API will not validate string length by default, will be only validated if string Schema version 2.0 is added in compatibility.

Notes