---
title: "Send a provider portal invitation"
method: POST
path: "/v1/provider-portal-invitations"
tags: ["ProviderPortalInvitations"]
---

# Send a provider portal invitation

`POST /v1/provider-portal-invitations`

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.

## Request body

- object
  - `employer_id` string, required — BlueHive employer identifier
  - `provider_external_id` string, required — Provider identifier from the source system (e.g., Enterprise Health)
  - `provider_name` string, required — Full name of the provider being invited
  - `provider_email` string, email, required — Email address to send the invitation to
  - `requestor_id` string, required — Identifier of the user requesting the invitation in the source system
  - `requestor_role` string — Role or authorization context of the requestor
  - `source_system` string, required — Source system originating the request (e.g., "enterprise_health")
  - `relationship_metadata` object — Optional employer-specific relationship or contract metadata
  - `custom_body` string — Optional HTML body content for the invitation email. Replaces the default greeting and description. Support contact line and CTA button are always shown.

## Response `200`

Default Response

- object
  - `invitation_id` string
  - `provider_external_id` string
  - `employer_id` string
  - `status` 'sent' | 'pending' | 'failed' | 'throttled'
  - `sent_at` string, date-time, nullable

## Other responses

- `400` — Default Response
- `401` — Default Response
- `403` — Default Response
- `500` — Default Response

---

[API](https://skmtc.net/bluehive-health/apis/bluehive-api.md) · [All operations](https://skmtc.net/bluehive-health/apis/bluehive-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bluehive-health/bluehive-api/revisions/ae97a9add0ba/schema)