Update Clerk sign-up

Update an in-progress sign-up in a connected Clerk application.

← All Clerk endpoints · Capability overview

PATCH/v1/clerk/sign-ups/{sign_up_id}

https://api.vee3.io/v1/clerk/sign-ups/{sign_up_id}

8 tokens

Update an in-progress sign-up in a connected Clerk application.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.update_sign_up

Parameters4 fields

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

sign_up_idstringRequired

Clerk sign-up id (su_...) to retrieve or update.

external_idstringOptional

External id for the guest signing up; copied to the user when sign-up completes.

custom_actionbooleanOptional

When true, marks the sign-up as a custom action.

Response12 fields

idstring

Clerk sign-up id (su_...).

statusstring

Sign-up status: "missing_requirements", "complete", or "abandoned".

email_addressstring

Email address associated with the in-progress sign-up.

phone_numberstring

Phone number associated with the in-progress sign-up.

usernamestring

Username associated with the in-progress sign-up.

first_namestring

First name collected during sign-up.

last_namestring

Last name collected during sign-up.

missing_fieldsstring[]

Fields still required before the sign-up can complete.

unverified_fieldsstring[]

Fields that still need verification.

created_user_idstring

Clerk user id created when the sign-up completed.

created_session_idstring

Clerk session id created when the sign-up completed.

abandon_atinteger

Unix timestamp in milliseconds when the sign-up will be abandoned.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/sign-ups/{sign_up_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "sign_up_id": "sign_up_2abc123"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Sign-up after updating external_id or custom_action.

updated_sign_up.json

{
  "id": "su_2abc123",
  "status": "missing_requirements",
  "email_address": "ada@example.com",
  "phone_number": null,
  "username": null,
  "first_name": "Ada",
  "last_name": "Lovelace",
  "missing_fields": [
    "password"
  ],
  "unverified_fields": [],
  "created_user_id": null,
  "created_session_id": null,
  "abandon_at": 1710086400000
}