Undo User Deletion

Create or submit user undo delete via the Junction API. Requires authentication with your team API key.

POST /v2/user/undo_delete

cURL

curl --request POST \
     --url {{BASE_URL}}/v2/user/undo_delete \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
     "client_user_id": "8DS6YRVBCSQQ4S0"
}
'

import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.user.undoDelete({ clientUserId: "<client_user_id>" });

from junction import Junction
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.user.undo_delete(client_user_id="<client_user_id>")

import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.user.requests.UndoDeleteUserRequest;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.user().undoDelete(
    UndoDeleteUserRequest.builder()
        .clientUserId("<client_user_id>")
        .build()
);

import (
    "context"

    junction "github.com/junction-api/junction-go"
    "github.com/junction-api/junction-go/client"
    "github.com/junction-api/junction-go/option"
)

c := client.NewClient(
    option.WithApiKey("YOUR_API_KEY"),
    option.WithBaseURL(junction.Environments.Sandbox),
)

clientUserId := "<client_user_id>"
response, err := c.User.UndoDelete(context.TODO(), &junction.UndoDeleteUserRequest{
    ClientUserId: &clientUserId,
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

200

{
  "success": true
}

{
  "detail": "<unknown>"
}

You can undo any user deletion that is still in its 7-day grace period.

Undoing a deletion does not restore any provider connections.

You cannot undo a deletion if you have already created a new user using the same client_user_id.

cURL

curl --request POST \
     --url {{BASE_URL}}/v2/user/undo_delete \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
     "client_user_id": "8DS6YRVBCSQQ4S0"
}
'

import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.user.undoDelete({ clientUserId: "<client_user_id>" });

from junction import Junction
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.user.undo_delete(client_user_id="<client_user_id>")

import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.user.requests.UndoDeleteUserRequest;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.user().undoDelete(
    UndoDeleteUserRequest.builder()
        .clientUserId("<client_user_id>")
        .build()
);

import (
    "context"

    junction "github.com/junction-api/junction-go"
    "github.com/junction-api/junction-go/client"
    "github.com/junction-api/junction-go/option"
)

c := client.NewClient(
    option.WithApiKey("YOUR_API_KEY"),
    option.WithBaseURL(junction.Environments.Sandbox),
)

clientUserId := "<client_user_id>"
response, err := c.User.UndoDelete(context.TODO(), &junction.UndoDeleteUserRequest{
    ClientUserId: &clientUserId,
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

Authorizations

x-vital-api-key · string · header · required

Vital Team API Key

Query Parameters

user_id · string<uuid> | null

User ID to undo deletion. Mutually exclusive with client_user_id.

client_user_id · string | null

Client User ID to undo deletion. Mutually exclusive with user_id.

Response

200

application/json

Successful Response

success · boolean · required

Whether operation was successful or not