update User Invite

ApiScope: manage.user.write
API Scope Level: ServiceSubscriberScope

Path Parameters

user_uuid string required

application/json

Request Body required

user object
firstName string
lastName string
userName string
email string
phone string
passwordExpires string
forcePasswordChange boolean
password string
nickName string
textNumber string
uuid string
pin int64
roleName string
latestInviteStatus string
latestInviteDate string
calendarUuid string
userAuthorities object[]
Array [
authority string
description string
]
userFeatures object[]
Array [
key string
name string
description string
signUpUrl string
informationUrl string
email string
uuid string
category string
]
userPreferences object[]
Array [
keyName string
value string
promptType string
possibleValues string
description string
]
dealerDepartmentUUID string
roleName string
userInviteType string
sendEmail boolean
sendText boolean

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

application/json

application/x-protobuf

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
userUuid string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "userUuid": "string"
}

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
userUuid string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "userUuid": "string"
}

Bad Request

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Unauthorized

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Forbidden

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Internal Server Error

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

PUT /v2/user/:user_uuid/invite

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

user_uuid — path required

Body required

{
  "user": {
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "email": "string",
    "phone": "string",
    "passwordExpires": "string",
    "forcePasswordChange": true,
    "password": "string",
    "nickName": "string",
    "textNumber": "string",
    "uuid": "string",
    "pin": 0,
    "roleName": "string",
    "latestInviteStatus": "string",
    "latestInviteDate": "string",
    "calendarUuid": "string",
    "userAuthorities": [
      {
        "authority": "string",
        "description": "string"
      }
    ],
    "userFeatures": [
      {
        "key": "string",
        "name": "string",
        "description": "string",
        "signUpUrl": "string",
        "informationUrl": "string",
        "email": "string",
        "uuid": "string",
        "category": "string"
      }
    ],
    "userPreferences": [
      {
        "keyName": "string",
        "value": "string",
        "promptType": "string",
        "possibleValues": "string",
        "description": "string"
      }
    ]
  },
  "dealerDepartmentUUID": "string",
  "roleName": "string",
  "userInviteType": "string",
  "sendEmail": true,
  "sendText": true
}

Accept

application/jsonapplication/x-protobuf

curl / cURL

curl -L -X PUT '/manage/v2/user/:user_uuid/invite' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "email": "string",
    "phone": "string",
    "passwordExpires": "string",
    "forcePasswordChange": true,
    "password": "string",
    "nickName": "string",
    "textNumber": "string",
    "uuid": "string",
    "pin": 0,
    "roleName": "string",
    "latestInviteStatus": "string",
    "latestInviteDate": "string",
    "calendarUuid": "string",
    "userAuthorities": [
      {
        "authority": "string",
        "description": "string"
      }
    ],
    "userFeatures": [
      {
        "key": "string",
        "name": "string",
        "description": "string",
        "signUpUrl": "string",
        "informationUrl": "string",
        "email": "string",
        "uuid": "string",
        "category": "string"
      }
    ],
    "userPreferences": [
      {
        "keyName": "string",
        "value": "string",
        "promptType": "string",
        "possibleValues": "string",
        "description": "string"
      }
    ]
  },
  "dealerDepartmentUUID": "string",
  "roleName": "string",
  "userInviteType": "string",
  "sendEmail": true,
  "sendText": true
}'

python / requests

curl -L -X PUT '/manage/v2/user/:user_uuid/invite' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "email": "string",
    "phone": "string",
    "passwordExpires": "string",
    "forcePasswordChange": true,
    "password": "string",
    "nickName": "string",
    "textNumber": "string",
    "uuid": "string",
    "pin": 0,
    "roleName": "string",
    "latestInviteStatus": "string",
    "latestInviteDate": "string",
    "calendarUuid": "string",
    "userAuthorities": [
      {
        "authority": "string",
        "description": "string"
      }
    ],
    "userFeatures": [
      {
        "key": "string",
        "name": "string",
        "description": "string",
        "signUpUrl": "string",
        "informationUrl": "string",
        "email": "string",
        "uuid": "string",
        "category": "string"
      }
    ],
    "userPreferences": [
      {
        "keyName": "string",
        "value": "string",
        "promptType": "string",
        "possibleValues": "string",
        "description": "string"
      }
    ]
  },
  "dealerDepartmentUUID": "string",
  "roleName": "string",
  "userInviteType": "string",
  "sendEmail": true,
  "sendText": true
}'

go / native

curl -L -X PUT '/manage/v2/user/:user_uuid/invite' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "email": "string",
    "phone": "string",
    "passwordExpires": "string",
    "forcePasswordChange": true,
    "password": "string",
    "nickName": "string",
    "textNumber": "string",
    "uuid": "string",
    "pin": 0,
    "roleName": "string",
    "latestInviteStatus": "string",
    "latestInviteDate": "string",
    "calendarUuid": "string",
    "userAuthorities": [
      {
        "authority": "string",
        "description": "string"
      }
    ],
    "userFeatures": [
      {
        "key": "string",
        "name": "string",
        "description": "string",
        "signUpUrl": "string",
        "informationUrl": "string",
        "email": "string",
        "uuid": "string",
        "category": "string"
      }
    ],
    "userPreferences": [
      {
        "keyName": "string",
        "value": "string",
        "promptType": "string",
        "possibleValues": "string",
        "description": "string"
      }
    ]
  },
  "dealerDepartmentUUID": "string",
  "roleName": "string",
  "userInviteType": "string",
  "sendEmail": true,
  "sendText": true
}'

nodejs / axios

curl -L -X PUT '/manage/v2/user/:user_uuid/invite' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "email": "string",
    "phone": "string",
    "passwordExpires": "string",
    "forcePasswordChange": true,
    "password": "string",
    "nickName": "string",
    "textNumber": "string",
    "uuid": "string",
    "pin": 0,
    "roleName": "string",
    "latestInviteStatus": "string",
    "latestInviteDate": "string",
    "calendarUuid": "string",
    "userAuthorities": [
      {
        "authority": "string",
        "description": "string"
      }
    ],
    "userFeatures": [
      {
        "key": "string",
        "name": "string",
        "description": "string",
        "signUpUrl": "string",
        "informationUrl": "string",
        "email": "string",
        "uuid": "string",
        "category": "string"
      }
    ],
    "userPreferences": [
      {
        "keyName": "string",
        "value": "string",
        "promptType": "string",
        "possibleValues": "string",
        "description": "string"
      }
    ]
  },
  "dealerDepartmentUUID": "string",
  "roleName": "string",
  "userInviteType": "string",
  "sendEmail": true,
  "sendText": true
}'

ruby / Net::HTTP

curl -L -X PUT '/manage/v2/user/:user_uuid/invite' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "email": "string",
    "phone": "string",
    "passwordExpires": "string",
    "forcePasswordChange": true,
    "password": "string",
    "nickName": "string",
    "textNumber": "string",
    "uuid": "string",
    "pin": 0,
    "roleName": "string",
    "latestInviteStatus": "string",
    "latestInviteDate": "string",
    "calendarUuid": "string",
    "userAuthorities": [
      {
        "authority": "string",
        "description": "string"
      }
    ],
    "userFeatures": [
      {
        "key": "string",
        "name": "string",
        "description": "string",
        "signUpUrl": "string",
        "informationUrl": "string",
        "email": "string",
        "uuid": "string",
        "category": "string"
      }
    ],
    "userPreferences": [
      {
        "keyName": "string",
        "value": "string",
        "promptType": "string",
        "possibleValues": "string",
        "description": "string"
      }
    ]
  },
  "dealerDepartmentUUID": "string",
  "roleName": "string",
  "userInviteType": "string",
  "sendEmail": true,
  "sendText": true
}'

csharp / RestSharp

curl -L -X PUT '/manage/v2/user/:user_uuid/invite' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "email": "string",
    "phone": "string",
    "passwordExpires": "string",
    "forcePasswordChange": true,
    "password": "string",
    "nickName": "string",
    "textNumber": "string",
    "uuid": "string",
    "pin": 0,
    "roleName": "string",
    "latestInviteStatus": "string",
    "latestInviteDate": "string",
    "calendarUuid": "string",
    "userAuthorities": [
      {
        "authority": "string",
        "description": "string"
      }
    ],
    "userFeatures": [
      {
        "key": "string",
        "name": "string",
        "description": "string",
        "signUpUrl": "string",
        "informationUrl": "string",
        "email": "string",
        "uuid": "string",
        "category": "string"
      }
    ],
    "userPreferences": [
      {
        "keyName": "string",
        "value": "string",
        "promptType": "string",
        "possibleValues": "string",
        "description": "string"
      }
    ]
  },
  "dealerDepartmentUUID": "string",
  "roleName": "string",
  "userInviteType": "string",
  "sendEmail": true,
  "sendText": true
}'

php / cURL

curl -L -X PUT '/manage/v2/user/:user_uuid/invite' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "email": "string",
    "phone": "string",
    "passwordExpires": "string",
    "forcePasswordChange": true,
    "password": "string",
    "nickName": "string",
    "textNumber": "string",
    "uuid": "string",
    "pin": 0,
    "roleName": "string",
    "latestInviteStatus": "string",
    "latestInviteDate": "string",
    "calendarUuid": "string",
    "userAuthorities": [
      {
        "authority": "string",
        "description": "string"
      }
    ],
    "userFeatures": [
      {
        "key": "string",
        "name": "string",
        "description": "string",
        "signUpUrl": "string",
        "informationUrl": "string",
        "email": "string",
        "uuid": "string",
        "category": "string"
      }
    ],
    "userPreferences": [
      {
        "keyName": "string",
        "value": "string",
        "promptType": "string",
        "possibleValues": "string",
        "description": "string"
      }
    ]
  },
  "dealerDepartmentUUID": "string",
  "roleName": "string",
  "userInviteType": "string",
  "sendEmail": true,
  "sendText": true
}'

java / OkHttp

curl -L -X PUT '/manage/v2/user/:user_uuid/invite' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "email": "string",
    "phone": "string",
    "passwordExpires": "string",
    "forcePasswordChange": true,
    "password": "string",
    "nickName": "string",
    "textNumber": "string",
    "uuid": "string",
    "pin": 0,
    "roleName": "string",
    "latestInviteStatus": "string",
    "latestInviteDate": "string",
    "calendarUuid": "string",
    "userAuthorities": [
      {
        "authority": "string",
        "description": "string"
      }
    ],
    "userFeatures": [
      {
        "key": "string",
        "name": "string",
        "description": "string",
        "signUpUrl": "string",
        "informationUrl": "string",
        "email": "string",
        "uuid": "string",
        "category": "string"
      }
    ],
    "userPreferences": [
      {
        "keyName": "string",
        "value": "string",
        "promptType": "string",
        "possibleValues": "string",
        "description": "string"
      }
    ]
  },
  "dealerDepartmentUUID": "string",
  "roleName": "string",
  "userInviteType": "string",
  "sendEmail": true,
  "sendText": true
}'

powershell / RestMethod

curl -L -X PUT '/manage/v2/user/:user_uuid/invite' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "firstName": "string",
    "lastName": "string",
    "userName": "string",
    "email": "string",
    "phone": "string",
    "passwordExpires": "string",
    "forcePasswordChange": true,
    "password": "string",
    "nickName": "string",
    "textNumber": "string",
    "uuid": "string",
    "pin": 0,
    "roleName": "string",
    "latestInviteStatus": "string",
    "latestInviteDate": "string",
    "calendarUuid": "string",
    "userAuthorities": [
      {
        "authority": "string",
        "description": "string"
      }
    ],
    "userFeatures": [
      {
        "key": "string",
        "name": "string",
        "description": "string",
        "signUpUrl": "string",
        "informationUrl": "string",
        "email": "string",
        "uuid": "string",
        "category": "string"
      }
    ],
    "userPreferences": [
      {
        "keyName": "string",
        "value": "string",
        "promptType": "string",
        "possibleValues": "string",
        "description": "string"
      }
    ]
  },
  "dealerDepartmentUUID": "string",
  "roleName": "string",
  "userInviteType": "string",
  "sendEmail": true,
  "sendText": true
}'