POST
/
v1
/
org
/
{org_id}
/
team
curl --request POST \
  --url https://api.tryvital.io/management/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,
    "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
  },
  "production": {
    "lab_tests_patient_sms_communication_enabled": true,
    "lab_tests_patient_email_communication_enabled": true,
    "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
  }
}

Org Management API is available for the Scale plan.

The base URL of this endpoint is https://api.tryvital.io/management/.

The endpoint accepts only Org Key (X-Vital-Org-Key). Team API Key is not applicable.

Authorizations

X-Vital-Org-Key
string
headerrequired

Path Parameters

org_id
string
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
event_type_prefixes
string[]
reject_duplicate_connection
boolean
default: false
brand_information
object

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

Response

200 - application/json
id
string
required
name
string
required
created_on
string
required
region
enum<string>
required
Available options:
us,
eu
environments
enum<string>[]
Available options:
production,
sandbox
sandbox
object
production
object
List TeamsGet Team