Capxul Docs
API referenceClient setup

Set org logo

Use the Core SDK to set org logo.

client.media.setOrgLogo

Use the Core SDK to set org logo.

Available in the Core SDK

The typed Core SDK operation is implemented. Live service behavior still depends on the configured environment.

Import and client prerequisite

import { createCapxulClient } from "@capxul/sdk";

const created = await createCapxulClient({
  publishableKey: "cap_pk_…",
});

if (!created.ok) throw created.error;
const client = created.value;

Usage

declare const input: { readonly orgId: string; readonly storageId: string };

const result = await client.media.setOrgLogo(input);

if (!result.ok) {
  console.error(result.error.code);
  return;
}

console.log(result.value);

Signature

client.media.setOrgLogo(input: { readonly orgId: string; readonly storageId: string; }, options?: { readonly signal?: AbortSignal; }): Promise<CapxulResult<{ readonly logoUrl: string | null; }>>;

Source: packages/sdk/src/surface/media.ts:26.

Parameters

input

Required.

{ readonly orgId: string; readonly storageId: string; }

options

Optional.

{ readonly signal?: AbortSignal; } | undefined

Returns

Promise<CapxulResult<{ readonly logoUrl: string | null }>>;

Read the ok discriminant before accessing value or error.

Errors

Expected failures resolve as { ok: false, error: CapxulError }; they are not thrown as the normal domain contract. Branch on result.ok and use the stable error.code. A pre-aborted AbortSignal returns a CANCELLED failure. Provider messages and internal causes are not public contracts.

Availability and evidence

Available in the Core SDK. Evidence classification: shipped-proven.

shipped-proven at the typed or hermetic Core SDK contract boundary. The callable surface and result mapping are covered by release-trunk type or hermetic tests. That does not by itself prove a live backend, provider, email, browser, or chain journey. Check the capability-status reference before presenting this operation as live.

On this page