Set custom text for a self-service profile

Updates text customizations for a given self-service profile, language and Self-Service Enterprise Configuration flow page.

PUT https://{tenantDomain}/api/v2/self-service-profiles/{id}/custom-text/{language}/{page}

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.SelfServiceProfiles.CustomText.Set(
        context.TODO(),
        "id",
        management.SelfServiceProfileCustomTextLanguageEnum(
            "en",
        ),
        management.SelfServiceProfileCustomTextPageEnum(
            "get-started",
        ),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.selfServiceProfiles.customText.set("id", "en", "get-started", {
        "key": "value",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.selfServiceProfiles.customText.set("id", "en", "get-started", {
        "key": "value",
    });
}
main();

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

import requests

url = "https://{tenantDomain}/api/v2/self-service-profiles/{id}/custom-text/{language}/{page}"

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/self-service-profiles/{id}/custom-text/{language}/{page}",
  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/self-service-profiles/{id}/custom-text/{language}/{page}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/self-service-profiles/{id}/custom-text/{language}/{page}")

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

200

{}

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

The id of the self-service profile.

language · enum<string> · required

The language of the custom text.

Available options: en

page · enum<string> · required

The page where the custom text is shown.

Available options: get-started

Body

application/jsonapplication/x-www-form-urlencoded

The list of text keys and values to customize the Self-Service Enterprise Configuration flow page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks.

{key} · string

Maximum string length: 2000

Response

200

application/json

Updated custom text.

The resulting list of custom text keys and values.

{key} · string