API Update/Replace Extension/User: How to remove values?

Question

I could not figure out a way to remove values from extensions contact information using the API.

Both Update Extension and Update/Replace User seem to not offer the functionality to remove values, e.g. the mobile phone number.

This is a common use case in our company, people having a mobile number migration to VOIP and therefore loose the mobile number. In such a case an automated process should remove the mobile number from the contact information.

I tried sending empty value (with " and without), sending null.

While everthing that is not a valid number returns a validation error, sending null (which I would have expected to be the right way as specified in JSON) does not send an error, but does not have an effect at all.

So how can I remove contact information using the API call?

Best answer by PhongVu

Just make a PUT call to this endpoint with the "mobilePhone":"".

See the example code below

// Use the RingCentral JS SDK
var p = { contact: { mobilePhone: ""}})
try{
  var r = await platform.put('/restapi/v1.0/account/~/extension/[extensionId]', p)
  var jsonObj = await r.json()
  console.log(JSON.stringify(jsonObj
}catch(e){
    console.log(e.message)
}

View original

PhongVu · Accepted Answer

Just make a PUT call to this endpoint with the "mobilePhone":"".

See the example code below

// Use the RingCentral JS SDK
var p = { contact: { mobilePhone: ""}})
try{
  var r = await platform.put('/restapi/v1.0/account/~/extension/[extensionId]', p)
  var jsonObj = await r.json()
  console.log(JSON.stringify(jsonObj
}catch(e){
    console.log(e.message)
}

Gary450190067 · Answer

Indeed, that worked. I had the impression I have tested everything without any positive result, looks like I have overseen the simplest option. Thanks!

API Update/Replace Extension/User: How to remove values?

Reply

Most helpful members this week

Cookie policy

Cookie settings

Reply

Related Posts

Update Extension - hidden field does not updateicon

Is there an API to remove a direct phone number from a user/ extension back to inventory?icon

Streamlining the application development process at RingCentral and bidding farewell to sandbox

remove developericon

Potential issue with address book update favorite contacts API endpointicon

Most helpful members this week

Sign up

Login with SSO

Login to the community

Login with SSO

Scanning file for viruses.

This file cannot be downloaded

Cookie policy

Cookie settings