Report an invitation status event

Reports a status transition event for a provider portal invitation. Called by the provider portal when a provider opens the email, clicks the signup link, or completes signup.

post/v1/provider-portal-invitations/events

Request body

event_type'signed_up' | 'opened' | 'clicked' required

The type of status event to report

invitation_idstring required

The ProviderPortalInvitation document _id

provider_idstring

The provider Chart/Provider _id in BlueHive (required for signed_up events)

metadataobject

Additional metadata about the event

Response

Default Response

successboolean

invitation_idstring

previous_statusstring

new_statusstring