Create Location

post https://api.ribbonhealth.com/v1/custom/locations

Create new locations and facilities.

Example Use Case

You want to add new urgent care locations (or labs, imaging centers, therapy centers, etc.) to an area that are not yet included in the existing Ribbon locations listings.

Body Params

A JSON object describing the location you want to create.

uuid

A UUID uniquely identifying this location

name

string | null

address

string

address_details

object

latitude

number

longitude

number

google_maps_link

url

phone_numbers

array of objects

phone_numbers

faxes

array of objects

Fax numbers associated with this location.

This property only appears for customers purchasing fax data. If you would like this property and are not receiving it, please reach out to support.

faxes

confidence

integer | null

Each location contains a confidence score. This score indicates the probability of the given provider practicing at said location with the included contact information

This field will only be populated for Ribbon-provided locations. Locations you create yourself will have a confidence score of null.

insurances

array of uuids

List of insurances UUIDs accepted at this location

insurances

tins

string

Comma separated list of standard 9-digit identification code(s) used by the IRS for business entities and used for contracting and paying provider/facility claims.

Responses

`address` and `name` pair already exists.

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.ribbonhealth.com/v1/custom/locations \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Location was successfully created.

400This request attempted to update with invalid schema or was missing required fields.

409A location with this address and name pair already exists.

`address` and `name` pair already exists.