Release Date: October 15, 2023

Overview

Version 2.11 of the AdvocateConnect API introduces several enhancements and new features aimed at improving functionality, performance, and user experience. This release focuses on expanding the capabilities for managing advocate profiles, enhancing security, and optimizing data retrieval processes.

New Features

1. Enhanced Profile Update Endpoint

• Endpoint: PUT /v1/advocates/{advocateId}
• Description: Allows for bulk updates of advocate profiles. You can now update multiple fields in a single request, including name, email, engagement score, and preferences.

• Example:

2. New Engagement Metrics Endpoint

• Endpoint: GET /v1/advocates/{advocateId}/engagement
• Description: Fetch detailed engagement metrics for advocates, including total contributions, referral activities, and recent activity timestamps.
• Benefits: This allows brands to better analyze advocate performance and tailor engagement strategies accordingly.

Improvements

1. Improved API Response Times

• Optimizations have been made to reduce latency in responses, particularly for large data sets. This enhances the overall performance of the API, ensuring faster data retrieval and updates.

2. Enhanced Security Features

• Implementation of stricter validation checks on authentication tokens to bolster security and prevent unauthorized access to advocate data.
• Updated encryption methods for sensitive data transmission to further protect user information.

Bug Fixes

1. Resolved Issues with User Preferences

• Fixed a bug that occasionally caused user preferences to not save correctly during updates, ensuring that all specified preferences are now accurately reflected in the advocate profile.

2. Minor UI/UX Improvements

• Adjusted error messages for clarity, making it easier for developers to understand issues when interacting with the API.
• Improved documentation readability and examples to enhance developer experience.

Deprecations

• The old engagement score retrieval endpoint (GET /v1/advocates/{advocateId}/score) has been deprecated in favor of the new engagement metrics endpoint. Users are encouraged to migrate to the new endpoint for better functionality.