Set a portal password by email

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/portal/change" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "portal": {
      "email": "jane@example.com",
      "password": "new-password"
    }
  }'

from exsited import build_client

client = build_client()

response = client.portals.set_portal_password(
    {"portal": {"email": "jane@example.com", "password": "new-password"}}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.portals.setPortalPassword({
    portal: {email: 'jane@example.com', password: 'new-password'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->portals->setPortalPassword([
    'portal' => ['email' => 'jane@example.com', 'password' => 'new-password'],
]);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.portals().setPortalPassword(
        Map.of("portal", Map.of("email", "jane@example.com", "password", "new-password")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Portals.SetPortalPasswordAsync(new Dictionary<string, object?>
{
    ["portal"] = new Dictionary<string, object?>
    {
        ["email"] = "jane@example.com",
        ["password"] = "new-password",
    },
});

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.portals.setPortalPassword({
  'portal': {'email': 'jane@example.com', 'password': 'new-password'},
});
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Portals().SetPortalPassword(context.Background(), map[string]any{
	"portal": map[string]any{
		"email":    "jane@example.com",
		"password": "new-password",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

POST

portal

change

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/portal/change" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "portal": {
      "email": "jane@example.com",
      "password": "new-password"
    }
  }'

from exsited import build_client

client = build_client()

response = client.portals.set_portal_password(
    {"portal": {"email": "jane@example.com", "password": "new-password"}}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.portals.setPortalPassword({
    portal: {email: 'jane@example.com', password: 'new-password'},
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->portals->setPortalPassword([
    'portal' => ['email' => 'jane@example.com', 'password' => 'new-password'],
]);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.portals().setPortalPassword(
        Map.of("portal", Map.of("email", "jane@example.com", "password", "new-password")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Portals.SetPortalPasswordAsync(new Dictionary<string, object?>
{
    ["portal"] = new Dictionary<string, object?>
    {
        ["email"] = "jane@example.com",
        ["password"] = "new-password",
    },
});

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.portals.setPortalPassword({
  'portal': {'email': 'jane@example.com', 'password': 'new-password'},
});
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Portals().SetPortalPassword(context.Background(), map[string]any{
	"portal": map[string]any{
		"email":    "jane@example.com",
		"password": "new-password",
	},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Send the portal user’s email and the new password under portal. No current password is asked for, and the old password cannot be put back afterwards. A successful call returns 202.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Body

application/json

portal

object

required

Show child attributes

Response

202

The new password is accepted.

Guides

API reference

Set a portal password by email

Authorizations

Body

Response