Update a phone notification template

PATCH https://{tenantDomain}/api/v2/branding/phone/templates/{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.UpdatePhoneTemplateRequestContent{}
    client.Branding.Phone.Templates.Update(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.branding.phone.templates.update("id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.branding.phone.templates.update("id", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/branding/phone/templates/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": {
    "from": "<string>",
    "body": {
      "text": "<string>",
      "voice": "<string>"
    }
  },
  "disabled": false
}
'

import requests

url = "https://{tenantDomain}/api/v2/branding/phone/templates/{id}"

payload = {
    "content": {
        "from": "<string>",
        "body": {
            "text": "<string>",
            "voice": "<string>"
        }
    },
    "disabled": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/branding/phone/templates/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'content' => [
        'from' => '<string>',
        'body' => [
                'text' => '<string>',
                'voice' => '<string>'
        ]
    ],
    'disabled' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/branding/phone/templates/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"content\": {\n    \"from\": \"<string>\",\n    \"body\": {\n      \"text\": \"<string>\",\n      \"voice\": \"<string>\"\n    }\n  },\n  \"disabled\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/branding/phone/templates/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"content\": {\n    \"from\": \"<string>\",\n    \"body\": {\n      \"text\": \"<string>\",\n      \"voice\": \"<string>\"\n    }\n  },\n  \"disabled\": false\n}"

response = http.request(request)
puts response.read_body

200

{
  "content": {
    "syntax": "<string>",
    "from": "<string>",
    "body": {
      "text": "<string>",
      "voice": "<string>"
    }
  },
  "disabled": false,
  "id": "<string>",
  "channel": "<string>",
  "customizable": true,
  "tenant": "<string>"
}

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

content · object

Show child attributes

disabled · boolean · default: false

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

Response

200

application/json

The phone notification template was updated.

content · object · required

Show child attributes

type · enum<string> · required

Available options: otp_verify, otp_enroll, change_password, blocked_account, password_breach

Maximum string length: 255

disabled · boolean · default: false · required

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

id · string

Required string length: 1 - 255

channel · string

customizable · boolean

tenant · string

Required string length: 1 - 255