Sign in
ProviderPortalInvitations

Send a provider portal invitation

Creates and sends an invitation email to a provider, inviting them to sign up for the BlueHive Provider Portal. If an invitation already exists for this employer+provider pair, appends a new send event rather than creating a duplicate.

post/v1/provider-portal-invitations

Request body

employer_idstring required

BlueHive employer identifier

provider_external_idstring required

Provider identifier from the source system (e.g., Enterprise Health)

provider_namestring required

Full name of the provider being invited

provider_emailstring email required

Email address to send the invitation to

requestor_idstring required

Identifier of the user requesting the invitation in the source system

requestor_rolestring

Role or authorization context of the requestor

source_systemstring required

Source system originating the request (e.g., "enterprise_health")

relationship_metadataobject

Optional employer-specific relationship or contract metadata

custom_bodystring

Optional HTML body content for the invitation email. Replaces the default greeting and description. Support contact line and CTA button are always shown.

Response

Default Response

invitation_idstring
provider_external_idstring
employer_idstring
status'sent' | 'pending' | 'failed' | 'throttled'
sent_atstring date-time nullable