Update Dealer Associate
updates dealerAssociates and returns dealerAssociateUuid if creation worked, return null with errors if create did not work. Since UserUUID and departmentUUID are needed to update the dealerAssociate, they will not be returned.
ApiScope: manage.dealerassociate.write
API Scope Level: DepartmentScope
Path Parameters
user_uuid string required
Unique identifier for an User
ServiceSubscriberDepartment string required
Unique identifier for a department
application/json
Request Body required
dealerAssociate object
changeValidStatus boolean
Responses
- 200
- 400
- 401
- 403
- 500
OK
application/json
application/x-protobuf
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
dealerAssociateUuid string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string",
"dealerAssociateUuid": "string"
}
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
apiRequestId string
dealerAssociateUuid string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string",
"dealerAssociateUuid": "string"
}
Bad Request
application/json
Schema
Example (from schema)
Schema
errors object[]
warnings object[]
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[]
warnings object[]
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[]
warnings object[]
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[]
warnings object[]
apiRequestId string
{
"errors": [
{
"errorCode": 0,
"errorTitle": "string",
"errorMessage": "string"
}
],
"warnings": [
{
"warningCode": 0,
"warningTitle": "string",
"warningMessage": "string"
}
],
"apiRequestId": "string"
}
POST /v2/department/:ServiceSubscriberDepartment/user/:user_uuid/update
Authorization
name: basicAuthtype: httpscheme: basic
Request
Request
curl / cURL
curl -L -X POST '/manage/v2/department/:ServiceSubscriberDepartment/user/:user_uuid/update' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerAssociate": {
"id": 0,
"uuid": "string",
"userUuid": "string",
"firstName": "string",
"lastName": "string",
"userName": "string",
"cellPhone": "string",
"textNumber": "string",
"isTextNumberVerified": true,
"emailAddress": "string",
"nickname": "string",
"associateDmsID": "string",
"imageUrl": "string",
"isValid": true,
"bio": "string",
"userInviteStatus": "string",
"defaultThreadOwnerUserUUID": "string",
"outOfOffice": true,
"outOfOfficeStartDate": "string",
"ssoFeatureEnabled": true,
"isDealerMappedToSsoPartner": true,
"isSsoPartnerMapped": true,
"department": {
"id": 0,
"name": "string",
"uuid": "string",
"calendarUuid": "string",
"brokerNumber": "string",
"communicationGroup": "string",
"departmentType": "string",
"phoneNumber": "string",
"textNumber": "string",
"emailAddress": "string",
"contactFName": "string",
"contactLName": "string",
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"isValid": true
}
},
"role": {
"roleName": "string",
"roleAcronym": "string"
}
},
"changeValidStatus": true
}'
python / requests
curl -L -X POST '/manage/v2/department/:ServiceSubscriberDepartment/user/:user_uuid/update' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerAssociate": {
"id": 0,
"uuid": "string",
"userUuid": "string",
"firstName": "string",
"lastName": "string",
"userName": "string",
"cellPhone": "string",
"textNumber": "string",
"isTextNumberVerified": true,
"emailAddress": "string",
"nickname": "string",
"associateDmsID": "string",
"imageUrl": "string",
"isValid": true,
"bio": "string",
"userInviteStatus": "string",
"defaultThreadOwnerUserUUID": "string",
"outOfOffice": true,
"outOfOfficeStartDate": "string",
"ssoFeatureEnabled": true,
"isDealerMappedToSsoPartner": true,
"isSsoPartnerMapped": true,
"department": {
"id": 0,
"name": "string",
"uuid": "string",
"calendarUuid": "string",
"brokerNumber": "string",
"communicationGroup": "string",
"departmentType": "string",
"phoneNumber": "string",
"textNumber": "string",
"emailAddress": "string",
"contactFName": "string",
"contactLName": "string",
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"isValid": true
}
},
"role": {
"roleName": "string",
"roleAcronym": "string"
}
},
"changeValidStatus": true
}'
go / native
curl -L -X POST '/manage/v2/department/:ServiceSubscriberDepartment/user/:user_uuid/update' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerAssociate": {
"id": 0,
"uuid": "string",
"userUuid": "string",
"firstName": "string",
"lastName": "string",
"userName": "string",
"cellPhone": "string",
"textNumber": "string",
"isTextNumberVerified": true,
"emailAddress": "string",
"nickname": "string",
"associateDmsID": "string",
"imageUrl": "string",
"isValid": true,
"bio": "string",
"userInviteStatus": "string",
"defaultThreadOwnerUserUUID": "string",
"outOfOffice": true,
"outOfOfficeStartDate": "string",
"ssoFeatureEnabled": true,
"isDealerMappedToSsoPartner": true,
"isSsoPartnerMapped": true,
"department": {
"id": 0,
"name": "string",
"uuid": "string",
"calendarUuid": "string",
"brokerNumber": "string",
"communicationGroup": "string",
"departmentType": "string",
"phoneNumber": "string",
"textNumber": "string",
"emailAddress": "string",
"contactFName": "string",
"contactLName": "string",
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"isValid": true
}
},
"role": {
"roleName": "string",
"roleAcronym": "string"
}
},
"changeValidStatus": true
}'
nodejs / axios
curl -L -X POST '/manage/v2/department/:ServiceSubscriberDepartment/user/:user_uuid/update' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerAssociate": {
"id": 0,
"uuid": "string",
"userUuid": "string",
"firstName": "string",
"lastName": "string",
"userName": "string",
"cellPhone": "string",
"textNumber": "string",
"isTextNumberVerified": true,
"emailAddress": "string",
"nickname": "string",
"associateDmsID": "string",
"imageUrl": "string",
"isValid": true,
"bio": "string",
"userInviteStatus": "string",
"defaultThreadOwnerUserUUID": "string",
"outOfOffice": true,
"outOfOfficeStartDate": "string",
"ssoFeatureEnabled": true,
"isDealerMappedToSsoPartner": true,
"isSsoPartnerMapped": true,
"department": {
"id": 0,
"name": "string",
"uuid": "string",
"calendarUuid": "string",
"brokerNumber": "string",
"communicationGroup": "string",
"departmentType": "string",
"phoneNumber": "string",
"textNumber": "string",
"emailAddress": "string",
"contactFName": "string",
"contactLName": "string",
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"isValid": true
}
},
"role": {
"roleName": "string",
"roleAcronym": "string"
}
},
"changeValidStatus": true
}'
ruby / Net::HTTP
curl -L -X POST '/manage/v2/department/:ServiceSubscriberDepartment/user/:user_uuid/update' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerAssociate": {
"id": 0,
"uuid": "string",
"userUuid": "string",
"firstName": "string",
"lastName": "string",
"userName": "string",
"cellPhone": "string",
"textNumber": "string",
"isTextNumberVerified": true,
"emailAddress": "string",
"nickname": "string",
"associateDmsID": "string",
"imageUrl": "string",
"isValid": true,
"bio": "string",
"userInviteStatus": "string",
"defaultThreadOwnerUserUUID": "string",
"outOfOffice": true,
"outOfOfficeStartDate": "string",
"ssoFeatureEnabled": true,
"isDealerMappedToSsoPartner": true,
"isSsoPartnerMapped": true,
"department": {
"id": 0,
"name": "string",
"uuid": "string",
"calendarUuid": "string",
"brokerNumber": "string",
"communicationGroup": "string",
"departmentType": "string",
"phoneNumber": "string",
"textNumber": "string",
"emailAddress": "string",
"contactFName": "string",
"contactLName": "string",
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"isValid": true
}
},
"role": {
"roleName": "string",
"roleAcronym": "string"
}
},
"changeValidStatus": true
}'
csharp / RestSharp
curl -L -X POST '/manage/v2/department/:ServiceSubscriberDepartment/user/:user_uuid/update' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerAssociate": {
"id": 0,
"uuid": "string",
"userUuid": "string",
"firstName": "string",
"lastName": "string",
"userName": "string",
"cellPhone": "string",
"textNumber": "string",
"isTextNumberVerified": true,
"emailAddress": "string",
"nickname": "string",
"associateDmsID": "string",
"imageUrl": "string",
"isValid": true,
"bio": "string",
"userInviteStatus": "string",
"defaultThreadOwnerUserUUID": "string",
"outOfOffice": true,
"outOfOfficeStartDate": "string",
"ssoFeatureEnabled": true,
"isDealerMappedToSsoPartner": true,
"isSsoPartnerMapped": true,
"department": {
"id": 0,
"name": "string",
"uuid": "string",
"calendarUuid": "string",
"brokerNumber": "string",
"communicationGroup": "string",
"departmentType": "string",
"phoneNumber": "string",
"textNumber": "string",
"emailAddress": "string",
"contactFName": "string",
"contactLName": "string",
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"isValid": true
}
},
"role": {
"roleName": "string",
"roleAcronym": "string"
}
},
"changeValidStatus": true
}'
php / cURL
curl -L -X POST '/manage/v2/department/:ServiceSubscriberDepartment/user/:user_uuid/update' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerAssociate": {
"id": 0,
"uuid": "string",
"userUuid": "string",
"firstName": "string",
"lastName": "string",
"userName": "string",
"cellPhone": "string",
"textNumber": "string",
"isTextNumberVerified": true,
"emailAddress": "string",
"nickname": "string",
"associateDmsID": "string",
"imageUrl": "string",
"isValid": true,
"bio": "string",
"userInviteStatus": "string",
"defaultThreadOwnerUserUUID": "string",
"outOfOffice": true,
"outOfOfficeStartDate": "string",
"ssoFeatureEnabled": true,
"isDealerMappedToSsoPartner": true,
"isSsoPartnerMapped": true,
"department": {
"id": 0,
"name": "string",
"uuid": "string",
"calendarUuid": "string",
"brokerNumber": "string",
"communicationGroup": "string",
"departmentType": "string",
"phoneNumber": "string",
"textNumber": "string",
"emailAddress": "string",
"contactFName": "string",
"contactLName": "string",
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"isValid": true
}
},
"role": {
"roleName": "string",
"roleAcronym": "string"
}
},
"changeValidStatus": true
}'
java / OkHttp
curl -L -X POST '/manage/v2/department/:ServiceSubscriberDepartment/user/:user_uuid/update' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerAssociate": {
"id": 0,
"uuid": "string",
"userUuid": "string",
"firstName": "string",
"lastName": "string",
"userName": "string",
"cellPhone": "string",
"textNumber": "string",
"isTextNumberVerified": true,
"emailAddress": "string",
"nickname": "string",
"associateDmsID": "string",
"imageUrl": "string",
"isValid": true,
"bio": "string",
"userInviteStatus": "string",
"defaultThreadOwnerUserUUID": "string",
"outOfOffice": true,
"outOfOfficeStartDate": "string",
"ssoFeatureEnabled": true,
"isDealerMappedToSsoPartner": true,
"isSsoPartnerMapped": true,
"department": {
"id": 0,
"name": "string",
"uuid": "string",
"calendarUuid": "string",
"brokerNumber": "string",
"communicationGroup": "string",
"departmentType": "string",
"phoneNumber": "string",
"textNumber": "string",
"emailAddress": "string",
"contactFName": "string",
"contactLName": "string",
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"isValid": true
}
},
"role": {
"roleName": "string",
"roleAcronym": "string"
}
},
"changeValidStatus": true
}'
powershell / RestMethod
curl -L -X POST '/manage/v2/department/:ServiceSubscriberDepartment/user/:user_uuid/update' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerAssociate": {
"id": 0,
"uuid": "string",
"userUuid": "string",
"firstName": "string",
"lastName": "string",
"userName": "string",
"cellPhone": "string",
"textNumber": "string",
"isTextNumberVerified": true,
"emailAddress": "string",
"nickname": "string",
"associateDmsID": "string",
"imageUrl": "string",
"isValid": true,
"bio": "string",
"userInviteStatus": "string",
"defaultThreadOwnerUserUUID": "string",
"outOfOffice": true,
"outOfOfficeStartDate": "string",
"ssoFeatureEnabled": true,
"isDealerMappedToSsoPartner": true,
"isSsoPartnerMapped": true,
"department": {
"id": 0,
"name": "string",
"uuid": "string",
"calendarUuid": "string",
"brokerNumber": "string",
"communicationGroup": "string",
"departmentType": "string",
"phoneNumber": "string",
"textNumber": "string",
"emailAddress": "string",
"contactFName": "string",
"contactLName": "string",
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"isValid": true
}
},
"role": {
"roleName": "string",
"roleAcronym": "string"
}
},
"changeValidStatus": true
}'