invite

POST /api/account/invite

Headers

X-Gatego-oid

Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

application/json

Body

can_view_carrier_ids array[integer(int64)]
can_view_other_carriers boolean
carrier_id integer(int64)
email string Required
role string Required

Values are ADMIN, CARRIER_ADMIN, DRIVER, GUARD, ORG_ADMIN, ORG_GROUP_ADMIN, RESTRICTED_GUARD, SIGNUP_SERVICE, SUPER_CARRIER_ADMIN, YARD_ADMIN, or YARD_DRIVER.
yard_id integer(int64)

Responses

201

Created
401

Unauthorized
403

Forbidden
404

Not Found

POST /api/account/invite

curl \
 -X POST http://localhost:8080/api/account/invite \
 -H "Content-Type: application/json" \
 -d '{"can_view_carrier_ids":[42],"can_view_other_carriers":true,"carrier_id":42,"email":"string","role":"ADMIN","yard_id":42}'

Request examples

# Headers

# Payload
{
  "can_view_carrier_ids": [
    42
  ],
  "can_view_other_carriers": true,
  "carrier_id": 42,
  "email": "string",
  "role": "ADMIN",
  "yard_id": 42
}