Update Team

Patch org team via the Junction API. Requires authentication with your team API key.

PATCH /v1/org/{org_id}/team/{team_id}

cURL

curl --request PATCH \
  --url https://api.management.junction.com/v1/org/{org_id}/team/{team_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Vital-Org-Key: <api-key>' \
  --data '{
  "name": "<string>",
  "sandbox": {
    "lab_tests_patient_sms_communication_enabled": true,
    "lab_tests_patient_email_communication_enabled": true,
    "event_type_prefixes": [
      "<string>"
    ]
  },
  "production": {
    "lab_tests_patient_sms_communication_enabled": true,
    "lab_tests_patient_email_communication_enabled": true,
    "event_type_prefixes": [
      "<string>"
    ]
  }
}'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "region": "us",
  "sandbox": {
    "lab_tests_patient_sms_communication_enabled": true,
    "lab_tests_patient_email_communication_enabled": true,
    "critical_result_notification_email": "[e-mail]",
    "brand_information": {
      "company_name": "<string>",
      "company_website": "",
      "support_email": "[e-mail]",
      "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
  },
  "production": {
    "lab_tests_patient_sms_communication_enabled": true,
    "lab_tests_patient_email_communication_enabled": true,
    "critical_result_notification_email": "[e-mail]",
    "brand_information": {
      "company_name": "<string>",
      "company_website": "",
      "support_email": "[e-mail]",
      "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
  },
  "integration_team_id": "<string>",
  "environments": [
    "production"
  ]
}

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

curl --request PATCH \
  --url https://api.management.junction.com/v1/org/{org_id}/team/{team_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Vital-Org-Key: <api-key>' \
  --data '{
  "name": "<string>",
  "sandbox": {
    "lab_tests_patient_sms_communication_enabled": true,
    "lab_tests_patient_email_communication_enabled": true,
    "event_type_prefixes": [
      "<string>"
    ]
  },
  "production": {
    "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

team_id · string<uuid> · required

Body

application/json

name · string | null

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(),/:'|&_\-\s’]{0,80}$

integration_team_id · string | null

Maximum string length: 256

sandbox · UpdateOrgTeamEnvironmentBody · object | null

Show child attributes

production · UpdateOrgTeamEnvironmentBody · object | null

Show child attributes

Response

200

application/json

Successful Response

id · string<uuid> · required

name · string · required

created_on · string<date-time> · required

region · enum<string> · required

Available options: us, eu

sandbox · ClientFacingOrgTeamEnvironment · object | null · required

Show child attributes

production · ClientFacingOrgTeamEnvironment · object | null · required

Show child attributes

integration_team_id · string | null

environments · enum<string>[]

Available options: production, sandbox