Skip to main content
S
Saurabh Mehta
Contributor ⭐️
May 18, 2022
Solved

API for changing engagement configuration

  • May 18, 2022
  • 4 replies
  • 97 views

Hi Experts,

Are there APIs available for following:

  1. Find an engagement by name
  2. Change configurations of an engagement. For example - add or remove URLs or Segments.

Appreciate your inputs.

 

Best regards,

Saurabh

 

Best answer by link_black

Thanks for posting to PX Community @Saurabh Mehta !

  1. PX does have Engagement APIs that can be used to retrieve Engagement details by Engagement Id and Type, but filtering by Engagement Name is not currently supported.
  2. PX does have additional Engagement APIs that can be used to set the Environment(s) and State (START or PAUSE), but there is currently no support for editing Audience Logic or other properties.

4 replies

link_black
link_blackAnswer
Gainsight Employee ⭐️⭐️
May 18, 2022

Thanks for posting to PX Community @Saurabh Mehta !

  1. PX does have Engagement APIs that can be used to retrieve Engagement details by Engagement Id and Type, but filtering by Engagement Name is not currently supported.
  2. PX does have additional Engagement APIs that can be used to set the Environment(s) and State (START or PAUSE), but there is currently no support for editing Audience Logic or other properties.
-- Link
    S
    Saurabh MehtaAuthor
    Contributor ⭐️
    May 19, 2022

    @link_black Thanks for the quick response. This is very helpful.

    W
    waqar
    Contributor ⭐️
    February 17, 2025

    ​@link_black I have a similar requirement where I have attached accounts to engagements. I want to query, filter and update accounts via API for engagements. So just checking whether its possible now? I went through API but don’t see any option for that. Hoping to get this feature as its so common. Please let me know if I am missing something. Thanks

     

    https://gainsightpx.docs.apiary.io/#reference/engagement/v1engagement/get-engagements

     

    link_black
    link_black
    Gainsight Employee ⭐️⭐️
    February 18, 2025

    ​@waqar Those types of PX API calls are not currently available.  These do seem like good candidates to for Product Ideas to submit for others to review, comment, and upvote, plus more importantly to for our PX Product Managers to consider adding in a future PX release. 

    -- Link
    Terms & ConditionsAccessibility statement