Documentation

Support

Follow this workflow to automate the process of adding or revoking an application API key.

Read time 1 minute

Last updated 2 days ago

Use the key update API to automate the process of adding or revoking an application API key.

Note

These actions are manually performed in the Vivox Developer Portal on an application's details page.

The key update API consists of the following REST endpoints:

developer-api.vivox.com/api/v1/applications/remote-api/key/add

developer-api.vivox.com/api/v1/applications/remote-api/key/revoke

To enable these endpoints, complete the following steps:

In the Vivox Developer Portal, in the left navigation pane, select the arrow next to your organization's name and select Settings.
On the Organization Settings page, in the Remote API section, enable the Enable Remote API checkbox. This generates a unique username and password that you use to call the two endpoints.
Select Update Organization.

You can then call these endpoints by using a tool such as cURL, Advanced REST Client (ARC), or Postman.