Genesys Cloud - Developer Announcements!

 View Only

Sign Up

Back to discussions
Expand all | Collapse all

Update to Returned total Count for GET /api/v2/outbound/campaigns and GET /api/v2/outbound/contactlists When Using IDs

  • 1.  Update to Returned total Count for GET /api/v2/outbound/campaigns and GET /api/v2/outbound/contactlists When Using IDs

    Posted 07-22-2025 12:28
    Edited by Ananya Singh 07-22-2025 12:41

    Summary

    We are updating the behavior of the total property in the responses from the following GET endpoints when queried using specific IDs:

    • GET /api/v2/outbound/campaigns
    • GET /api/v2/outbound/contactlists

    Currently, this total value is set based on how many IDs the client passes to the endpoint rather than the number of entities returned. As a result, calling the endpoint with X number of IDs, and getting Y number of entities back will give a total of X in the response.

    We are changing this behavior so that the total property will now reflect Y — the number of entities actually returned — instead of X. This brings it in line with the standard behavior of other GET endpoints.

    Effective Date

    Friday, August 22, 2025

    Details

    This change addresses a source of confusion for customers. In all other scenarios, the total property reflects the number of entities returned in the response. However, when using these specific GET endpoints with ID filters, the total has been based on the number of IDs submitted, not the actual results.

    This inconsistency reduces the utility of the total property and makes the response harder to interpret. By aligning this behavior with the rest of the platform, we aim to enhance clarity and consistency.

    Customer Impact

    The impact to customers is expected to be minimal.

    • This change is informational in nature and does not alter the entities returned or the request structure.
    • Customers may notice a different total value when using ID parameters, as it will now represent the count of actual results returned (Y) rather than the count of IDs passed in (X).
    • This update helps standardize response behavior and reduce confusion.

    Impacted Resources

    GET /api/v2/outbound/campaigns (when the id parameter is populated)

    GET /api/v2/outbound/contactlists (when the id parameter is populated)

    Issue References

    [OV-2712]

    Contacts

    @Casey Greene  

    Please reply to this announcement with any questions. This helps the wider developer community benefit from the discussion. We encourage you to use this thread before contacting the designated person directly. Thank you for your understanding.



Related Content