Update the phone provider

Update a phone provider. The credentials object requires different properties depending on the phone provider (which is specified using the name property).

PATCH https://{tenantDomain}/api/v2/branding/phone/providers/{id}

Go

Go

package example

import (
    context "context"

    phone "github.com/auth0/go-auth0/management/management/branding/phone"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &phone.UpdateBrandingPhoneProviderRequestContent{}
    client.Branding.Phone.Providers.Update(
        context.TODO(),
        "id",
        request,
    )
}

200

{
  "id": "<string>",
  "tenant": "<string>",
  "disabled": true,
  "configuration": {
    "sid": "<string>",
    "delivery_methods": [],
    "default_from": "<string>",
    "mssid": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Required string length: 1 - 255

Body

application/jsonapplication/x-www-form-urlencoded

name · enum<string>

Name of the phone notification provider

Available options: twilio, custom

Required string length: 1 - 100

disabled · boolean

Whether the provider is enabled (false) or disabled (true).

credentials · object

Provider credentials required to use authenticate to the provider.

Option 1

Option 2

Show child attributes

configuration · object

Option 1

Option 2

Show child attributes

Response

200

application/json

Phone provider successfully updated.

Phone provider configuration schema

name · enum<string> · required

Name of the phone notification provider

Available options: twilio, custom

Required string length: 1 - 100

id · string

Required string length: 1 - 255

tenant · string

The name of the tenant

Required string length: 1 - 255

channel · enum<string>

This depicts the type of notifications this provider can receive.

Available options: phone

Maximum string length: 100

disabled · boolean

Whether the provider is enabled (false) or disabled (true).

configuration · object

Option 1

Option 2

Show child attributes

created_at · string<date-time>

The provider's creation date and time in ISO 8601 format

Maximum string length: 27

updated_at · string<date-time>

The date and time of the last update to the provider in ISO 8601 format

Maximum string length: 27