How to get Default DealerAssociate (SystemUser) for a department

This document is designed to help you understand how to retrieve default dealerAssociate for a department. To get this data, you first need your credentials. If you don't already have one, head over to the Authentication and Authorization page to see how you can request for credentials from us. Use the endpoint below to fetch the Default DealerAssociate (SystemUser) associated with a given Department UUID

What is a Default DealerAssociate (SystemUser)?

A Default DealerAssociate is a virtual user in the myKaarma system used to manage unassigned calls, messages, DealerOrders, and appointments within a department.

Use Cases for Assignment to Default DealerAssociate:

Entity	Condition	Assigned to Default DealerAssociate
Text/Call	Customer thread is not assigned to any DealerAssociate	Yes
DealerOrder	Pulled from DMS, Associate DMS ID not matching any DealerAssociate in the system	Yes
Appointment	Pulled from DMS, Associate DMS ID not matching any DealerAssociate in the system	Yes
Appointment	Created with No Preference and dealer configuration allows default assignment	Yes

Request

HTTP request

POST  https://api.mykaarma.com/manage/v2/departments/{departmentUUID}/dealerAssociate/default

Parameters

Path parameter:

Parameter Name	Value	Description	Required
departmentUUID	String	Unique identifier of department	Yes

Authorization

This request requires the following authorization scopes:

Scope	Level	Description
manage.dealerassociate.default.read	Department	Authorises client to read default dealerassociate related data

Curl

curl -X 'GET' \
  'https://api.mykaarma.com/manage/v2/departments/{departmentUUID}/dealerAssociate/default' \
  -H 'accept: application/json' \
  -H 'Authorization: {{basic_auth_token}}'

Response

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "dealerAssociate": {
    "uuid": "string",
    "userUuid": "string",
    "firstName": "string",
    "lastName": "string",
    "cellPhone": "string",
    "textNumber": "string",
    "emailAddress": "string",
    "nickname": "string",
    "associateDmsID": "string",
    "imageUrl": "string",
    "isValid": true,
    "bio": "string",
    "defaultThreadOwnerUserUUID": "string",
    "outOfOffice": true,
    "outOfOfficeStartDate": "string",
    "role": {
      "roleName": "string",
      "roleAcronym": "string"
    },
    "department": {
      "name": "string",
      "uuid": "string",
      "departmentType": "string",
      "dealer": {
        "name": "string",
        "uuid": "string",
        "isValid": true
      }
    }
  }
}