Clerk API (unofficial showcase)
PATCH/sign_ups/{id}

Update a sign-up

Updates an existing sign-up with the fields you provide. Use external_id to associate the sign-up with an identifier from your external system, or set custom_action to mark it as a custom action. The response includes the sign-up's current status and verification details.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
idstringrequired
The ID of the sign-up to update.

Optional sign-up fields to update.

external_idstringoptional
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.
custom_actionbooleanoptional
If true, the sign-up will be marked as a custom action.

2 status codes
200Returns the updated sign-up attempt, including its status, required and missing fields, and verification details.
objectstringrequired
Allowed:sign_up_attempt
idstringrequired
statusstringrequired
Allowed:missing_requirementscompleteabandoned
required_fieldsarray<string>required
optional_fieldsarray<string>required
missing_fieldsarray<string>required
unverified_fieldsarray<string>required
verificationsobjectrequired
usernamestringrequired
email_addressstringrequired
phone_numberstringrequired
web3_walletstringrequired
password_enabledbooleanrequired
first_namestringrequired
last_namestringrequired
unsafe_metadataobjectoptional
public_metadataobjectoptional
custom_actionbooleanrequired
external_idstringrequired
created_session_idstringrequired
created_user_idstringrequired
abandon_atintegerrequired
Unix timestamp at which the user abandoned the sign up attempt.
legal_accepted_atintegerrequired
Unix timestamp at which the user accepted the legal requirements.
timezonestringoptional
The IANA timezone associated with the sign-up attempt.
localestringoptional
The user locale preference for the sign-up specified as a BCP-47 language tag.
external_accountobjectdeprecatedoptional
403Returned when authorization is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 403 is returned when authorization is invalid. The id path parameter must identify the sign-up to update.