Set custom text for a specific prompt

Set custom text for a specific prompt. Existing texts will be overwritten.

PUT https://{tenantDomain}/api/v2/prompts/{prompt}/custom-text/{language}

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    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 := map[string]any{
        "key": "value",
    }
    client.Prompts.CustomText.Set(
        context.TODO(),
        management.PromptGroupNameEnumLogin.Ptr(),
        management.PromptLanguageEnumAm.Ptr(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.prompts.customText.set("login", "am", {
        "key": "value",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.prompts.customText.set("login", "am", {
        "key": "value",
    });
}
main();

curl --request PUT \
  --url https://{tenantDomain}/api/v2/prompts/{prompt}/custom-text/{language} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://{tenantDomain}/api/v2/prompts/{prompt}/custom-text/{language}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/prompts/{prompt}/custom-text/{language}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  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.put("https://{tenantDomain}/api/v2/prompts/{prompt}/custom-text/{language}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/prompts/{prompt}/custom-text/{language}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

prompt · enum<string> · requis

Name of the prompt

Options disponibles: login, login-id, login-password, login-passwordless, login-email-verification, signup, signup-id, signup-password, phone-identifier-enrollment, phone-identifier-challenge, email-identifier-challenge, reset-password, custom-form, consent, customized-consent, logout, mfa-push, mfa-otp, mfa-voice, mfa-phone, mfa-webauthn, mfa-sms, mfa-email, mfa-recovery-code, mfa, status, device-flow, email-verification, email-otp-challenge, organizations, invitation, common, passkeys, captcha, brute-force-protection, async-approval-flow, confirmation

language · enum<string> · requis

Language to update.

Options disponibles: am, ar, ar-EG, ar-SA, az, bg, bn, bs, ca-ES, cnr, cs, cy, da, de, el, en, en-CA, es, es-419, es-AR, es-MX, et, eu-ES, fa, fi, fr, fr-CA, fr-FR, gl-ES, gu, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, kn, ko, lt, lv, mk, ml, mn, mr, ms, my, nb, nl, nn, no, pa, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, so, sq, sr, sv, sw, ta, te, th, tl, tr, uk, ur, vi, zgh, zh-CN, zh-HK, zh-MO, zh-TW

Corps

application/jsonapplication/x-www-form-urlencoded

An object containing custom dictionaries for a group of screens.

Réponse

200

Prompt dictionaries successfully updated.