Sign Ups

Update a sign-up

Changed on

Update the sign-up with the given ID

patch/sign_ups/{id}

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/sign_ups/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The ID of the sign-up to update

Request body

external_idstring nullable

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_actionboolean nullable

If true, the sign-up will be marked as a custom action.

Response

Success

object'sign_up_attempt' required
idstring required
status'missing_requirements' | 'complete' | 'abandoned' required
required_fieldsstring[] required
optional_fieldsstring[] required
missing_fieldsstring[] required
unverified_fieldsstring[] required
usernamestring nullable required
email_addressstring nullable required
phone_numberstring nullable required
web3_walletstring nullable required
password_enabledboolean required
first_namestring nullable required
last_namestring nullable required
unsafe_metadataobject
public_metadataobject
custom_actionboolean required
external_idstring nullable required
created_session_idstring nullable required
created_user_idstring nullable required
abandon_atinteger required

Unix timestamp at which the user abandoned the sign up attempt.

legal_accepted_atinteger nullable required

Unix timestamp at which the user accepted the legal requirements.

timezonestring nullable

The IANA timezone associated with the sign-up attempt.

localestring nullable

The user locale preference for the sign-up specified as a BCP-47 language tag.

external_accountobject

Example response

{
  "abandon_at": 1700690400000,
  "legal_accepted_at": 1700690400000,
  "timezone": "America/New_York",
  "locale": "en-US"
}

Changes