Skip to main content
POST
/
v1
/
org
/
{org_id}
/
team
curl --request POST \
  --url https://api.management.junction.com/v1/org/{org_id}/team \
  --header 'Content-Type: application/json' \
  --header 'X-Vital-Org-Key: <api-key>' \
  --data '{
  "name": "<string>",
  "region": "us",
  "lab_tests_patient_sms_communication_enabled": true,
  "lab_tests_patient_email_communication_enabled": true,
  "event_type_prefixes": [
    "<string>"
  ]
}'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "region": "us",
  "environments": [
    "production"
  ],
  "sandbox": {
    "lab_tests_patient_sms_communication_enabled": true,
    "lab_tests_patient_email_communication_enabled": true,
    "critical_result_notification_email": "jsmith@example.com",
    "brand_information": {
      "company_name": "<string>",
      "company_website": "<string>",
      "support_email": "jsmith@example.com",
      "support_contact": "<string>",
      "company_address": "<string>",
      "brand_color": "<string>"
    },
    "logo_url": "<string>",
    "reject_duplicate_connection": false,
    "sdk_per_device_activity_timeseries": false,
    "partial_webhooks_enabled": true,
    "minor_ordering_enabled": true
  },
  "production": {
    "lab_tests_patient_sms_communication_enabled": true,
    "lab_tests_patient_email_communication_enabled": true,
    "critical_result_notification_email": "jsmith@example.com",
    "brand_information": {
      "company_name": "<string>",
      "company_website": "<string>",
      "support_email": "jsmith@example.com",
      "support_contact": "<string>",
      "company_address": "<string>",
      "brand_color": "<string>"
    },
    "logo_url": "<string>",
    "reject_duplicate_connection": true,
    "sdk_per_device_activity_timeseries": true,
    "partial_webhooks_enabled": true,
    "minor_ordering_enabled": true
  }
}
Junction Management API is available for the Scale plan.
The base URL of this endpoint is https://api.management.junction.com/.The endpoint accepts only Management Key (X-Management-Key). Team API Key is not accepted.
curl --request POST \
  --url https://api.management.junction.com/v1/org/{org_id}/team \
  --header 'Content-Type: application/json' \
  --header 'X-Vital-Org-Key: <api-key>' \
  --data '{
  "name": "<string>",
  "region": "us",
  "lab_tests_patient_sms_communication_enabled": true,
  "lab_tests_patient_email_communication_enabled": true,
  "event_type_prefixes": [
    "<string>"
  ]
}'

Authorizations

​
X-Management-Key
string
header
required

Path Parameters

​
org_id
string<uuid>
required

Body

application/json
​
name
string
required

A human readable name of this Team. It is primarily used by Vital Dashboard.

In the Vital Link widget, you are by default represented as the Team name. However, if you have set Brand Information for the environment, the Company Name takes precedence.

In Vital Lab Testing, all communications use only Brand Information. Team name is ignored.

See also: sandbox.brand_information and production.brand_information.

​
region
enum<string>
required
Available options:
us,
eu
​
lab_tests_patient_sms_communication_enabled
boolean
default:true
​
lab_tests_patient_email_communication_enabled
boolean
default:true
​
critical_result_notification_email
string<email> | null
​
brand_information
object | null

Information of your brand.

In the Vital Link widget, you are by default represented as the Team name. However, if you configure Brand Information for the environment, the Company Name takes precedence.

In Vital Lab Testing, all communications use only Brand Information. Team name is ignored.

​
logo_url
string<uri> | null
Required string length: 1 - 2083
​
reject_duplicate_connection
boolean
default:false
​
sdk_per_device_activity_timeseries
boolean
default:false
​
partial_webhooks_enabled
boolean | null
default:false
​
minor_ordering_enabled
boolean | null
default:false
​
id
string<uuid> | null

Response

Successful Response

​
id
string<uuid>
required
​
name
string
required
​
created_on
string<date-time>
required
​
region
enum<string>
required
Available options:
us,
eu
​
sandbox
object | null
required
​
production
object | null
required
​
environments
enum<string>[]