curl --request PATCH \
--url https://api.management.junction.com/v1/org/{org_id}/team/{team_id} \
--header 'Content-Type: application/json' \
--header 'X-Management-Key: <management-key>' \
--data '{
"name": "<string>",
"integration_team_id": "<string>",
"sandbox": {
"lab_tests_patient_sms_communication_enabled": true,
"lab_tests_patient_email_communication_enabled": true
},
"production": {
"lab_tests_patient_sms_communication_enabled": true,
"lab_tests_patient_email_communication_enabled": true
}
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"region": "us",
"sandbox": {
"order_sms_reminders_enabled": false,
"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": "",
"support_email": "help@tryvital.io",
"support_contact": "",
"company_address": "",
"brand_color": ""
},
"logo_url": "<string>",
"reject_duplicate_connection": false,
"sdk_per_device_activity_timeseries": false,
"partial_webhooks_enabled": false,
"minor_ordering_enabled": false,
"patient_experience": false
},
"production": {
"order_sms_reminders_enabled": false,
"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": "",
"support_email": "help@tryvital.io",
"support_contact": "",
"company_address": "",
"brand_color": ""
},
"logo_url": "<string>",
"reject_duplicate_connection": false,
"sdk_per_device_activity_timeseries": false,
"partial_webhooks_enabled": false,
"minor_ordering_enabled": false,
"patient_experience": false
},
"integration_team_id": "<string>",
"environments": [
"production"
]
}{
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Team
Update Team
Update an organization team. Junction Connect integrations can update the integration team reference.
PATCH
/
v1
/
org
/
{org_id}
/
team
/
{team_id}
curl --request PATCH \
--url https://api.management.junction.com/v1/org/{org_id}/team/{team_id} \
--header 'Content-Type: application/json' \
--header 'X-Management-Key: <management-key>' \
--data '{
"name": "<string>",
"integration_team_id": "<string>",
"sandbox": {
"lab_tests_patient_sms_communication_enabled": true,
"lab_tests_patient_email_communication_enabled": true
},
"production": {
"lab_tests_patient_sms_communication_enabled": true,
"lab_tests_patient_email_communication_enabled": true
}
}'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"region": "us",
"sandbox": {
"order_sms_reminders_enabled": false,
"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": "",
"support_email": "help@tryvital.io",
"support_contact": "",
"company_address": "",
"brand_color": ""
},
"logo_url": "<string>",
"reject_duplicate_connection": false,
"sdk_per_device_activity_timeseries": false,
"partial_webhooks_enabled": false,
"minor_ordering_enabled": false,
"patient_experience": false
},
"production": {
"order_sms_reminders_enabled": false,
"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": "",
"support_email": "help@tryvital.io",
"support_contact": "",
"company_address": "",
"brand_color": ""
},
"logo_url": "<string>",
"reject_duplicate_connection": false,
"sdk_per_device_activity_timeseries": false,
"partial_webhooks_enabled": false,
"minor_ordering_enabled": false,
"patient_experience": false
},
"integration_team_id": "<string>",
"environments": [
"production"
]
}{
"team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}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 PATCH \
--url https://api.management.junction.com/v1/org/{org_id}/team/{team_id} \
--header 'Content-Type: application/json' \
--header 'X-Management-Key: <management-key>' \
--data '{
"name": "<string>",
"integration_team_id": "<string>",
"sandbox": {
"lab_tests_patient_sms_communication_enabled": true,
"lab_tests_patient_email_communication_enabled": true
},
"production": {
"lab_tests_patient_sms_communication_enabled": true,
"lab_tests_patient_email_communication_enabled": true
}
}'
Authorizations
Body
application/json
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.
Pattern:
^[A-Za-zÀ-ÖØ-öø-ÿ0-9(),/:'|&_\- ’]{0,80}$Maximum string length:
256Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Successful Response
Available options:
us, eu Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
production, sandbox Was this page helpful?