Skip to main content

personUpdates

Subscribe to real-time updates for a specific person. This subscription provides live notifications when a person is added or removed.

Authentication Requirements​

Requires authentication and the company:receive_person_updates permission.

Business Rules​

  • The person must exist and be accessible to the user
  • User must be a company or brand admin
  • Updates are delivered in real-time as they occur

Error Conditions​

  • Person not found if the person ID doesn't exist or is not accessible
  • Authentication required if not logged in
  • Permission denied if user lacks access to the person's domain
personUpdates(
  companyId: ID!
  email: Email!
): PersonSubscriptionsPayload!

Arguments​

personUpdates.companyId ● ID! non-null scalar​

The Company ID associated to the person updates.

personUpdates.email ● Email! non-null scalar​

The Person login identifier for which updates will be received.

Type​

PersonSubscriptionsPayload object​