Skip to main content

Update DealerAssociate Group​


ApiScope: manage.dealerassociate.group
API Scope Level: DepartmentScope
Path Parameters
    ServiceSubscriberDepartment string required
    dealerAssociateGroup string required
Query Parameters
    includeInvalid boolean
Request Body required
    name The new or the existing name of the DA Group/Team. When not passed it will remain the same
    addDealerAssociateUuids The list of DA UUIDs which needs to be added to this DA Group/Team.[]
    deleteDealerAssociateUuids The list of DA UUIDs which needs to be removed from this DA Group/Team.[]
    groupPhoneNumber Phone number of the DA Group/Team. When not passed it will remain the same
    isValid The isValid parameter is for activating and deactivating the DA Group/Team. When not passed it will remain the same
    isDefaultCommunicationDealerAssociateGroup To make this DA Group/Team as the DefaultCommunicationDealerAssociateGroup or not. When not passed it will remain the same
    defaultDealerAssociateUuid This is the UUID of the DA which is the default DA for this Group/Team. When not passed it will remain the same
    addPurposeKeys The list of DA Group Purpose Type/Category Keys which needs to be added to this DA Group/Team.[]
    removePurposeKeys The list of DA Group Purpose Type/Category Keys which needs to be removed from this DA Group/Team.[]
    addAuthorities object[]
  • Array [
    • authority string
    description string
  • ]
    • removeAuthorities object[]
  • Array [
    • authority string
    description string
  • ]
    • enableGroupThreadOwnership DA Group/Team will own thread, not its members
Responses

OK

Schema
    errors object[]
  • Array [
    • errorCode int32
    errorTitle string
    errorMessage string
  • ]
    • warnings object[]
  • Array [
    • warningCode int32
    warningTitle string
    warningMessage string
  • ]
    • apiRequestId string
POST /v2/department/:ServiceSubscriberDepartment/dealerAssociateGroup/:dealerAssociateGroup

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL
/manage
Username
Password
ServiceSubscriberDepartment — path required
dealerAssociateGroup — path required
includeInvalid — query
Body required
{

  "name": "string",

  "addDealerAssociateUuids": [

    "string"

  ],

  "deleteDealerAssociateUuids": [

    "string"

  ],

  "groupPhoneNumber": "string",

  "isValid": true,

  "isDefaultCommunicationDealerAssociateGroup": true,

  "defaultDealerAssociateUuid": "string",

  "addPurposeKeys": [

    "string"

  ],

  "removePurposeKeys": [

    "string"

  ],

  "addAuthorities": [

    {

      "authority": "string",

      "description": "string"

    }

  ],

  "removeAuthorities": [

    {

      "authority": "string",

      "description": "string"

    }

  ],

  "enableGroupThreadOwnership": true

}
Accept
curl / cURL
curl -L -X POST '/manage/v2/department/:ServiceSubscriberDepartment/dealerAssociateGroup/:dealerAssociateGroup' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "string",
  "addDealerAssociateUuids": [
    "string"
  ],
  "deleteDealerAssociateUuids": [
    "string"
  ],
  "groupPhoneNumber": "string",
  "isValid": true,
  "isDefaultCommunicationDealerAssociateGroup": true,
  "defaultDealerAssociateUuid": "string",
  "addPurposeKeys": [
    "string"
  ],
  "removePurposeKeys": [
    "string"
  ],
  "addAuthorities": [
    {
      "authority": "string",
      "description": "string"
    }
  ],
  "removeAuthorities": [
    {
      "authority": "string",
      "description": "string"
    }
  ],
  "enableGroupThreadOwnership": true
}'