Genesys Cloud - Developer Community!

 View Only

Sign Up

  • 1.  How to set agent onqueue via API

    Posted 12-16-2025 06:58

    Hi all, 

    is it possible to set an agent to "onqueue" status via API? 
    How does it work? The API documentation says nothing about this... 

    Is it possible via patch /api/v2/users/{userId}/presences/purecloud ?

    The /api/v2/users/{userId}/routingstatus API does not allow the onqueue status to set. Am I right?

    Regards, 

    Thomas


    #PlatformAPI

    ------------------------------
    Thomas Schepers
    Professional Service Engineer
    ------------------------------


  • 2.  RE: How to set agent onqueue via API

    Posted 12-16-2025 07:57

    Hello,

    Yes. That's indeed done using PATCH /api/v2/users/{userId}/presences/purecloud with a body that points to the id of the OnQueue presence like:

    {
      "presenceDefinition": {
        "id": "ID_OF_THE_PRESENCE_DEFINITION"
      }
    }

    You can get the id of the presence definition representing the OnQueue system presence with GET /api/v2/presence/definitions

    Regards,



    ------------------------------
    Jerome Saint-Marc
    Senior Development Support Engineer
    ------------------------------