Skip to main content

personsUpdates

Subscribe to real-time updates for all persons within a specific company. This subscription provides live notifications when persons are added or removed.

Authentication Requirements​

Requires authentication and the company:receive_person_updates permission.

Business Rules​

  • Only receives updates for persons belonging to the specified company
  • User must be a company or brand admin
  • Updates are delivered in real-time as they occur

Error Conditions​

  • Authentication required if not logged in
  • Permission denied if user lacks access to the specified brand
personsUpdates(
  companyId: ID!
): PersonSubscriptionsPayload!

Arguments​

personsUpdates.companyId ● ID! non-null scalar​

The Company ID associated to the persons updates.

Type​

PersonSubscriptionsPayload object​