Skip to main content
POST
Create Pulse

Authorizations

Authorization
string
header
required

Include an OAuth 2.0 bearer token in the Authorization header. See Authentication.

Headers

Idempotency-Key
string<uuid>

A UUID v4 used to safely retry this request without creating a duplicate. See Idempotency.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Body

application/json
patient
object
required
payerId
string<uuid>
required

The payer ID. See the Sohar payer list

Example:

"62308"

providerGroupId
string<uuid>

Optional provider group ID. When provided, Sohar selects request providers only from this group.

id
string

An optional identifier for the pulse

Maximum string length: 255
Example:

"123456"

Response

A pulse ID

pulseId
string<uuid>

The Sohar ID for the request

Example:

"fb701ac1-1246-4860-b1ec-bd916b97a991"

id
string | null

An optional identifier for the pulse. If not provided in the request, this field will be omitted from the response.

Example:

"123456"