Skip to content

Latest commit

 

History

History
85 lines (56 loc) · 4.22 KB

README.md

File metadata and controls

85 lines (56 loc) · 4.22 KB

SignUps

(SignUps)

Overview

Available Operations

  • Get - Retrieve a sign-up by ID
  • Update - Update a sign-up

Get

Retrieve the details of the sign-up with the given ID

Example Usage

using Clerk.BackendAPI;
using Clerk.BackendAPI.Models.Components;

var sdk = new ClerkBackendApi(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.SignUps.GetAsync(id: "<id>");

// handle response

Parameters

Parameter Type Required Description
Id string ✔️ The ID of the sign-up to retrieve

Response

GetSignUpResponse

Errors

Error Type Status Code Content Type
Clerk.BackendAPI.Models.Errors.ClerkErrors 403 application/json
Clerk.BackendAPI.Models.Errors.SDKError 4XX, 5XX */*

Update

Update the sign-up with the given ID

Example Usage

using Clerk.BackendAPI;
using Clerk.BackendAPI.Models.Components;
using Clerk.BackendAPI.Models.Operations;

var sdk = new ClerkBackendApi(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.SignUps.UpdateAsync(
    id: "signup_1234567890abcdef",
    requestBody: new UpdateSignUpRequestBody() {
        ExternalId = "ext_id_7890abcdef123456",
        CustomAction = false,
    }
);

// handle response

Parameters

Parameter Type Required Description Example
Id string ✔️ The ID of the sign-up to update signup_1234567890abcdef
RequestBody UpdateSignUpRequestBody ➖ N/A

Response

UpdateSignUpResponse

Errors

Error Type Status Code Content Type
Clerk.BackendAPI.Models.Errors.ClerkErrors 403 application/json
Clerk.BackendAPI.Models.Errors.SDKError 4XX, 5XX */*