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}

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using System.Collections.Generic;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.Prompts.CustomText.SetAsync(
            prompt: PromptGroupNameEnum.Login,
            language: PromptLanguageEnum.Am,
            request: new Dictionary<string, object?>(){
                ["key"] = "value",
            }
        );
    }

}

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,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.PromptGroupNameEnum;
import com.auth0.client.mgmt.types.PromptLanguageEnum;
import java.util.HashMap;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .token("<token>")
            .build();

        client.prompts().customText().set(
            PromptGroupNameEnum.LOGIN,
            PromptLanguageEnum.AM,
            new HashMap<String, Object>() {{
                put("key", "value");
            }}
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Types\PromptGroupNameEnum;
use Auth0\SDK\API\Management\Types\PromptLanguageEnum;

$client = new Management(
    token: '<token>',
);
$client->prompts->customText->set(
    PromptGroupNameEnum::Login->value,
    PromptLanguageEnum::Am->value,
    [
        'key' => "value",
    ],
);

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

client.prompts.custom_text.set(
    prompt="login",
    language="am",
    request={
        "key": "value"
    },
)

require "auth0"

client = Auth0::Management.new(token: "<token>")

client.prompts.custom_text.set(
  prompt: "login",
  language: "am",
  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 '{}'

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

prompt · enum<string> · required

Name of the prompt

Available options: 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> · required

Language to update.

Available options: 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

Body

application/jsonapplication/x-www-form-urlencoded

An object containing custom dictionaries for a group of screens.

Response

200

Prompt dictionaries successfully updated.