Request a portal password reset link

cURL

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

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.portals.createPortalResetLink({portal: {email: 'jane@example.com'}});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

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

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.portals.portals_dto.PortalsDto.PortalResetLink;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<PortalResetLink> response = client.portals().createPortalResetLink(
        Map.of("portal", Map.of("email", "jane@example.com")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

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

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.portals.createPortalResetLink({
  'portal': {'email': 'jane@example.com'},
});
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().CreatePortalResetLink(context.Background(), map[string]any{
	"portal": map[string]any{"email": "jane@example.com"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "message": "<string>",
  "object": "<string>"
}

POST

portal

reset_link

cURL

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

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.portals.createPortalResetLink({portal: {email: 'jane@example.com'}});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

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

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.portals.portals_dto.PortalsDto.PortalResetLink;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<PortalResetLink> response = client.portals().createPortalResetLink(
        Map.of("portal", Map.of("email", "jane@example.com")));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

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

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.portals.createPortalResetLink({
  'portal': {'email': 'jane@example.com'},
});
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().CreatePortalResetLink(context.Background(), map[string]any{
	"portal": map[string]any{"email": "jane@example.com"},
}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "message": "<string>",
  "object": "<string>"
}

Send the portal user’s email under portal. The response holds a message and an object key. An email that belongs to no portal user 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

The reset link request is accepted; a message.

message

string

object

string

Guides

API reference

Request a portal password reset link

Authorizations

Body

Response