Blockstream Enterprise
ReferenceAPI ReferenceRecipient Groups

Add Member Recipient Groups

Add Member Recipient Groups.

Request

RecipientGroupsAddMemberRequest
interface RecipientGroupsAddMemberRequest {
  action: 'edit'
  resource: string
  details: {
    recipient_ids: string[]
  }
}

Prop

Type

Response

RecipientGroupsAddMemberResponse_success
interface RecipientGroupsAddMemberResponse_success {
  status: 'success'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
  details: {}
  metadata: unknown
}

Prop

Type

RecipientGroupsAddMemberResponse_failed | pending | unauthorized | rejected
interface RecipientGroupsAddMemberResponse_failed | pending | unauthorized | rejected {
  status: 'failed' | 'pending' | 'unauthorized' | 'rejected'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
}

Prop

Type

Example

Example
import { resourceSchema } from '@blockstream/ecs-js-sdk'
import { broadcastRequest } from './broadcaster'

const response = await broadcastRequest<
  typeof resourceSchema.shape.recipient-groups.shape.add-member
>(
  {
    action: 'edit',
    resource: '/recipient-groups/{group_id}/recipients/add',
    details: {
      // TODO: fill in required fields
    },
  },
  blockstream,
)

Delete Recipient Groups

Delete Recipient Groups.

Remove Member Recipient Groups

Remove Member Recipient Groups.

On this page

Request
Response
Example