Customers

Update redirect URLs on an active setup link

PATCH

/customers/{id}/setup_links/{link_id}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://api.kirimdev.com/v1/customers/cus_01HXYZABCDEFGHJKMNPQRSTVWX/setup_links/csl_01HXYZABCDEFGHJKMNPQRSTVWX"

  payload := strings.NewReader("{ \"success_redirect_url\": \"https://example.com\", \"failure_redirect_url\": \"https://example.com\" }")

  req, _ := http.NewRequest("PATCH", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://api.kirimdev.com/v1/customers/cus_01HXYZABCDEFGHJKMNPQRSTVWX/setup_links/csl_01HXYZABCDEFGHJKMNPQRSTVWX';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"success_redirect_url":"https://example.com","failure_redirect_url":"https://example.com"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

use std::str::FromStr;
use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.kirimdev.com/v1/customers/cus_01HXYZABCDEFGHJKMNPQRSTVWX/setup_links/csl_01HXYZABCDEFGHJKMNPQRSTVWX";

    let payload = json!({
        "success_redirect_url": "https://example.com",
        "failure_redirect_url": "https://example.com"
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request PATCH \
  --url https://api.kirimdev.com/v1/customers/cus_01HXYZABCDEFGHJKMNPQRSTVWX/setup_links/csl_01HXYZABCDEFGHJKMNPQRSTVWX \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "success_redirect_url": "https://example.com", "failure_redirect_url": "https://example.com" }'

Recover from a typo in success_redirect_url / failure_redirect_url without revoking and regenerating the link. Only works while status = active; pass null to clear a redirect.

Authorizations

bearerAuth

Parameters

Path Parameters

required

Public Kirimdev end-customer ID.

string

/^cus_[0-9A-HJKMNP-TV-Z]{26}$/

Example

cus_01HXYZABCDEFGHJKMNPQRSTVWX

Public Kirimdev end-customer ID.

link_id

required

Public setup-link ID belonging to this customer.

string

/^csl_[0-9A-HJKMNP-TV-Z]{26}$/

Example

csl_01HXYZABCDEFGHJKMNPQRSTVWX

Public setup-link ID belonging to this customer.

Request Body

application/json

object

success_redirect_url

Any of:

string
null

string format: uri

<= 2048 characters

failure_redirect_url

Any of:

string
null

string format: uri

<= 2048 characters

Example ^generated

{
  "success_redirect_url": "https://example.com",
  "failure_redirect_url": "https://example.com"
}

Responses

200

Updated setup link

application/json

object

data

required

object

required

string

object

required

string

Allowed values: customer_setup_link

customer_id

required

string

status

required

string

Allowed values: active consumed expired revoked

token_last4

required

string

expires_at

required

string format: date-time

consumed_at

required

string | null format: date-time

success_redirect_url

required

Where the tenant is redirected after successful Embedded Signup. We append ?customer_id=&account_id=&status=success on the redirect.

string | null format: uri

failure_redirect_url

required

Where the tenant is redirected on failure (link error, Meta signup cancelled, etc.). We append ?customer_id=&status=failed&reason=<code>.

string | null format: uri

created_at

required

string format: date-time

request_id

required

Unique request identifier to include when contacting support.

string

Example

{
  "data": {
    "id": "csl_01HXYZABCDEFGHJKMNPQRSTVWX",
    "object": "customer_setup_link",
    "status": "active"
  },
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

400

Validation failure

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

Human-readable explanation of the error.

string

param

Request field associated with the error, when applicable.

string

request_id

required

Unique request identifier to include when contacting support.

string

Examples

default

A field value is invalid.

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_field_value",
    "message": "A field value is invalid.",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

401

Authentication failure

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

Human-readable explanation of the error.

string

param

Request field associated with the error, when applicable.

string

request_id

required

Unique request identifier to include when contacting support.

string

Examples

default

The provided API key is invalid.

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "The provided API key is invalid.",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

402

Billing / entitlement gate — subscription inactive, quota exceeded, or plan tier missing a feature (feature_not_entitled). Upgrade to continue.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

Human-readable explanation of the error.

string

param

Request field associated with the error, when applicable.

string

request_id

required

Unique request identifier to include when contacting support.

string

Examples

default

Your trial has ended or subscription is inactive. Upgrade to continue.

{
  "error": {
    "type": "permission_error",
    "code": "subscription_inactive",
    "message": "Your trial has ended or subscription is inactive. Upgrade to continue.",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

404

Resource not found

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

Human-readable explanation of the error.

string

param

Request field associated with the error, when applicable.

string

request_id

required

Unique request identifier to include when contacting support.

string

Examples

default

Resource not found.

{
  "error": {
    "type": "not_found",
    "code": "resource_not_found",
    "message": "Resource not found.",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

409

Conflict (e.g. template already exists, webhook subscription disabled, setup link inactive)

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

Human-readable explanation of the error.

string

param

Request field associated with the error, when applicable.

string

request_id

required

Unique request identifier to include when contacting support.

string

Examples

default

Setup link is no longer active and cannot be modified.

{
  "error": {
    "type": "conflict",
    "code": "setup_link_inactive",
    "message": "Setup link is no longer active and cannot be modified.",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

429

Rate limit exceeded

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

Human-readable explanation of the error.

string

param

Request field associated with the error, when applicable.

string

request_id

required

Unique request identifier to include when contacting support.

string

Examples

default

Rate limit exceeded.

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded.",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

500

Internal server error

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

Human-readable explanation of the error.

string

param

Request field associated with the error, when applicable.

string

request_id

required

Unique request identifier to include when contacting support.

string

Examples

default

An unexpected error occurred.

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred.",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

Update redirect URLs on an active setup link

Authorizations

Parameters

Path Parameters

Example

Example

Request Body

Example generated

Responses

200

Example

400

Examples

401

Examples

402

Examples

404

Examples

409

Examples

429

Examples

500

Examples

Example ^generated