PATCH /users/{user-id}/authentication/phoneMethods/{phoneAuthenticationMethod-id}

Update a user's phone number associated with a phone authentication method object. You can't change a phone's type. To change a phone's type, add a new number of the desired type and then delete the object with the original type. If a user is enabled by policy to use SMS to sign in and the mobile number is changed, the system will attempt to register the number for use in that system. Self-service operations aren't supported.

Servers

Path parameters

Name Type Required Description
user-id String Yes

The unique identifier of user

phoneAuthenticationMethod-id String Yes

The unique identifier of phoneAuthenticationMethod

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.