ReferenceAPI ReferenceSigners
Edit Signers
Edit Signers.
Request
interface SignersEditRequest {
action: 'edit'
resource: string
details: {
name: string | undefined
}
}Prop
Type
Response
interface SignersEditResponse_success {
status: 'success'
error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
message?: string | undefined
details: {
sid: string
name: string
type: 'amp' | 'ecs'
location: 'hosted' | 'external'
created_at: string
created_by: string
updated_at: string
updated_by: string
}
metadata: unknown
}Prop
Type
interface SignersEditResponse_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.signers.shape.edit
>(
{
action: 'edit',
resource: '/signers/{id}',
details: {
// TODO: fill in required fields
},
},
blockstream,
)