Create a client account

post

https://api.kalepa.com/external/client-accounts

Create a single client account. Set org_group if your organization uses org groups. The server validates (org_group, sub_org_group) against your allowed groups configuration.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

A client account row. external_id is your own natural identifier for the row (the ID your source system assigns); it is unique within (org_group, sub_org_group).

org_group

string | null

The org group of the record. Set it on create if your organization uses org groups. Must be an org group your API client can access.

sub_org_group

string | null

Optional sub-group scope. Requires org_group; must be one of your allowed sub_org_groups.

external_id

string

required

length ≥ 1

Your own natural identifier for this account (the ID your source system assigns).

name

string | null

address_1

string | null

address_2

string | null

city

string | null

state

string | null

postal_code

string | null

county

string | null

country

string | null

phone

string | null

extension

string | null

fax

string | null

primary_contact

string | null

alternate_id

string | null

company_type_id

string | null

sic_code

string | null

fein

string | null

account_number

string | null

ticker_or_ciq_id

string | null

business_industry

string | null

state_of_incorporation

string | null

business_ownership

string | null

status

string | null

Free-form status string. Different clients use different vocabularies (e.g. Active, Terminated).

physical_international_address

string | null

Flag indicating whether the physical address is international. Free-form string (e.g. Yes/No).

mailing_international_address

string | null

Flag indicating whether the mailing address is international. Free-form string (e.g. Yes/No).

mailing_address_1

string | null

mailing_address_2

string | null

mailing_city

string | null

mailing_state

string | null

mailing_postal_code

string | null

mailing_country

string | null

Responses

400

The request is invalid.

401

The bearer token is missing or invalid.

403

The bearer token is missing or invalid.

409

Duplicate (org_group, sub_org_group, external_id).

422

org_group/sub_org_group rejected by the configured groups for this client.

500

An unexpected error occurred.

201Client account created.