ReferenceAPI ReferenceCustomers
Create Customers
Create Customers.
Request
interface CustomersCreateRequest {
action: 'add'
resource: '/customers'
details: {
id: string
name: string
display_name: string
description: string | undefined
status: 'active' | 'pending' | 'suspended' | 'closed' | 'archived' | 'maintenance' | undefined
}
}Prop
Type
Response
interface CustomersCreateResponse_success {
status: 'success'
error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
message?: string | undefined
details: {
id: string
name: string
display_name: string
description: string | undefined
public_key: string
svix_app_id: string | undefined
svix_magic_link: string | undefined
is_default: boolean
status: 'active' | 'disabled' | 'archived'
created_at: string
created_by: string
updated_at: string
updated_by: string
}
metadata: unknown
}Prop
Type
interface CustomersCreateResponse_pending {
status: 'pending'
error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
message?: string | undefined
details: {
proposal_id: string
}
}Prop
Type
Example
import { resourceSchema } from '@blockstream/ecs-js-sdk'
import { broadcastRequest } from './broadcaster'
const response = await broadcastRequest<
typeof resourceSchema.shape.customers.shape.create
>(
{
action: 'add',
resource: '/customers',
details: {
// TODO: fill in required fields
},
},
blockstream,
)