Create or Resend Invite

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

POST /v1/org/{org_id}/invite

cURL

curl --request POST \
  --url https://api.management.junction.com/v1/org/{org_id}/invite \
  --header 'Content-Type: application/json' \
  --header 'X-Vital-Org-Key: <api-key>' \
  --data '{
  "email": "<string>"
}'

200

{}

{
  "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

curl --request POST \
  --url https://api.management.junction.com/v1/org/{org_id}/invite \
  --header 'Content-Type: application/json' \
  --header 'X-Vital-Org-Key: <api-key>' \
  --data '{
  "email": "<string>"
}'

Authorizations

X-Management-Key · string · header · required

Path Parameters

org_id · string<uuid> · required

Body

application/json

email · string · required

role · enum<string> string · default: org_admin

Available options: org_admin, team_admin

team_role_bindings · TeamRoleBinding · object[] | null

Show child attributes

Response

200

application/json

Successful Response

status · enum<string> · required

Available options: invite_created, invite_resent, already_in_org