Skip to content

Members API

The members endpoints allow you to manage individual users within a memberbase. Members are identified by an external ref that your system controls, making it straightforward to synchronise your user base with Publisher.

Key operations include:

  • Bulk upsert -- create or update members in batch by providing an array of refs and optional attributes.
  • Get by ref -- retrieve a single member's record using their ref and memberbase ID.
  • List members -- paginate through members in a memberbase with optional ref-based filtering.
  • Bulk delete -- remove members from a memberbase in batch.

All member mutations are idempotent. Upserting a member that already exists updates their record rather than producing a conflict. Attribute changes take effect immediately for targeting and delivery.

Endpoints

EndpointDescription
POST /publisher.v1/member/listPaginate through members with optional filtering
POST /publisher.v1/member/getGet a single member by memberbase + ref
POST /publisher.v1/member/bulk-upsertCreate or update members in batch
POST /publisher.v1/member/bulk-deleteRemove members in batch

See the full interactive reference on the API Reference page.