How can I disable a user/extension via the 3CX Configuration API?

[pedrotofani]

Hi everyone,

I'm trying to disable a user/extension through an integration, but I can’t find any specific endpoint or field in the documentation.

I’ve checked the "3CX Configuration API Endpoint Specification" documentation, but I only found information about deleting users (including bulk delete). I couldn’t locate anything that explains how to disable an extension or set the “Disable Extension” flag through the API.

Is deleting the user the only available method?
Or is there a way to update a specific field on the user entity to mark the extension as disabled?

Any guidance would be appreciated.
Thanks!

 

[edossantos_sipcaller]

Are you using the REST API or the .NET API?

In the .NET API, the Extension interface has the Enabled property for this, which can be set to true or false. For example:

Extension ext = (Extension) PhoneSystem.Root.GetDNByNumber("100");
ext.Enabled = false;
ext.Save();

 

[pedrotofani]

I am using REST API

 

[edossantos_sipcaller]

You will need to use this:
https://www.3cx.com/docs/configuration-rest-api-endpoints/

And use a PATCH HTTP request to update your user.

 

[pedrotofani]

The documentation is not so clear. But what I did understand is that I need to use this Endpoint: https://{{PBX_FQDN}}/xapi/v1/Users

But what field should I set to true/false? Enabled?

 

[edossantos_sipcaller]

Well, I never tried using that endpoint to set the Enabled property to false. So I guess you will need to try. You probably need to send the entire JSON with the user's data. So try this:
1) Use a GET request to get the details of your user. This will return JSON.
2) Use a PATCH request to update the details of that user. Use the same JSON, and add Enabled = false to it.

When invoking the PATCH request, you need to add the user id as part of the URL:
PATCH https://{{PBX_FQDN}}/xapi/v1/Users({{UserId}})

 

[pedrotofani]

Thank you very much Ernesto!