Clerk docs

Sign-ups

Update a sign-up

Update the sign-up with the given ID

SecuritybearerAuth
Request
path Parameters
id
required
string

The ID of the sign-up to update

Request Body schema: application/json
external_id
string or null

The ID of the guest attempting to sign up as used in your external systems or your previous authentication solution. This will be copied to the resulting user when the sign-up is completed.

Responses
200

Success

403

Authorization invalid

patch/sign_ups/{id}
Request samples
application/json
{
  • "external_id": "string"
}
Response samples
application/json
{
  • "object": "sign_up_attempt",
  • "id": "string",
  • "status": "missing_requirements",
  • "required_fields": [
    ],
  • "optional_fields": [
    ],
  • "missing_fields": [
    ],
  • "unverified_fields": [
    ],
  • "verifications": { },
  • "username": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "web3_wallet": "string",
  • "password_enabled": true,
  • "first_name": "string",
  • "last_name": "string",
  • "unsafe_metadata": { },
  • "public_metadata": { },
  • "custom_action": true,
  • "external_id": "string",
  • "created_session_id": "string",
  • "created_user_id": "string",
  • "abandon_at": 0,
  • "legal_accepted_at": 1700690400000,
  • "external_account": { }
}