API Reference
  1. Spartera API Documentation
  2. Companies

Update an existing company by ID

patch
https://api.spartera.com/companies/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 255
^[a-zA-Z0-9_-]+$

Unique identifier for the Company

Body Params

Update schema for modifying Company

int64

References industries.industry_id — Available industry categories for asset classification. Based on US NAISC codes.. See GET /industries for valid values. Optional.

int64

References countries.country_id — List of countries of the world. See GET /countries for valid values. Optional.

string

Optional.

string

Optional.

string

Required. Must be unique.

string

Required. Must be unique.

int64

Current balance of credits for this company (buyer)

boolean

Optional.

string

Stripe Connect account ID for marketplace sellers

string

Status of the Stripe account (verified, pending, etc.)

float

Vendor revenue share as 0-1 fraction (e.g. 0.8500 = 85%). Default 0.8000 = standard 80/20 terms.

date-time

UTC datetime the current vendor_share_percent was explicitly set. NULL = never explicitly set (standard terms since signup).

string
enum

Partnership type: SELF_MANAGED (default, partner runs their own products) or CUSTODIAN (Spartera manages for them)

Allowed:
string

Where payout statements and payout-setup invites are sent. Required in practice for CUSTODIAN partners, who have no user records.

string

Human contact at the provider for payment matters.

string
enum

STRIPE_CONNECT (automated transfer, requires stripe_account_status='verified'), MANUAL (paid outside the platform, recorded with an external reference), or NONE (not payable yet).

Allowed:
string

Negotiated settlement terms for MANUAL vendors, e.g. NET_30. Free text by design - negotiated per vendor, not machine-enforced.

string

How to pay this vendor: AP portal, PO requirements, invoice-first, remittance address. NEVER account or routing numbers.

date-time

UTC datetime the provider authorised Spartera to resell their data under the Spartera brand. NULL = never authorised.

boolean

Company-wide default for AI/ML training permission on this seller's products. Inherited by any asset or endpoint whose ai_training_permitted is NULL.

date-time

UTC datetime the company affirmed it holds the rights necessary to permit AI/ML training. NULL = never affirmed.

Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?