API reference

Subscriber operations

Search a project’s subscribers and remove a subscriber by ID.

Subscriber operations require the subscribers permission.

`subscribers.list`

List subscribers request

GET /project/{projectId}/subscribers

import { subscribers } from '@orvelt/business';

const result = await subscribers.list({
  projectId: 'PROJECT_ID',
  page: 1,
  limit: 25,
  query: '[email protected]',
});

if (result.error) throw new Error(result.error.message);
console.log(result.data);

curl --request GET \
  --url "$ORVELT_API_BASE_URL/project/PROJECT_ID/subscribers?page=1&limit=25&query=customer%40example.com" \
  --header "x-api-key: $ORVELT_BUSINESS_API_KEY"

`subscribers.block`

Block subscriber request

DELETE /project/{projectId}/subscribers/{id}

import { subscribers } from '@orvelt/business';

const result = await subscribers.block({
  projectId: 'PROJECT_ID',
  id: 'SUBSCRIBER_ID',
});

if (result.error) throw new Error(result.error.message);

curl --request DELETE \
  --url "$ORVELT_API_BASE_URL/project/PROJECT_ID/subscribers/SUBSCRIBER_ID" \
  --header "x-api-key: $ORVELT_BUSINESS_API_KEY"

Search for the subscriber first and confirm the returned ID before sending the deletion request.

Delivery and preverification

Create, email, and track customer-addressed opinion links.

Knowledge-base operations

List, add, update, and delete organization knowledge-base items.

On this page

subscribers.listList subscribers request subscribers.blockBlock subscriber request