update dealer associate group purpose types

**DO NOT USE: TALK TO YATHARTH**
ApiScope: manage.dealerassociate.group.purpose.write
API Scope Level: ServiceSubscriberScope

Path Parameters

purposeKey string required

application/json

Request Body required

name The new or the existing name of the DA Group Purpose Type. If nothing is passed then it remain the same.
authoritiesToAdd object[]
Array [
authority string
description string
]
authoritiesToRemove object[]
Array [
authority string
description string
]

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
purposeDto object
key The key which is a unique identifier for a group purpose type. Can only contain lowercase characters and "-","_"
name The name for the group purpose type
authorities object[]
Array [
authority string
description string
]
uuid string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "purposeDto": {
    "key": "string",
    "name": "string",
    "authorities": [
      {
        "authority": "string",
        "description": "string"
      }
    ],
    "uuid": "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
purposeDto object
key The key which is a unique identifier for a group purpose type. Can only contain lowercase characters and "-","_"
name The name for the group purpose type
authorities object[]
Array [
authority string
description string
]
uuid string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "purposeDto": {
    "key": "string",
    "name": "string",
    "authorities": [
      {
        "authority": "string",
        "description": "string"
      }
    ],
    "uuid": "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"
}

PATCH /v2/purpose/:purposeKey

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

purposeKey — path required

Body required

{
  "name": "string",
  "authoritiesToAdd": [
    {
      "authority": "string",
      "description": "string"
    }
  ],
  "authoritiesToRemove": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}

Accept

application/jsonapplication/x-protobuf

curl / cURL

curl -L -X PATCH '/manage/v2/purpose/:purposeKey' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "string",
  "authoritiesToAdd": [
    {
      "authority": "string",
      "description": "string"
    }
  ],
  "authoritiesToRemove": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

python / requests

curl -L -X PATCH '/manage/v2/purpose/:purposeKey' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "string",
  "authoritiesToAdd": [
    {
      "authority": "string",
      "description": "string"
    }
  ],
  "authoritiesToRemove": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

go / native

curl -L -X PATCH '/manage/v2/purpose/:purposeKey' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "string",
  "authoritiesToAdd": [
    {
      "authority": "string",
      "description": "string"
    }
  ],
  "authoritiesToRemove": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

nodejs / axios

curl -L -X PATCH '/manage/v2/purpose/:purposeKey' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "string",
  "authoritiesToAdd": [
    {
      "authority": "string",
      "description": "string"
    }
  ],
  "authoritiesToRemove": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

ruby / Net::HTTP

curl -L -X PATCH '/manage/v2/purpose/:purposeKey' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "string",
  "authoritiesToAdd": [
    {
      "authority": "string",
      "description": "string"
    }
  ],
  "authoritiesToRemove": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

csharp / RestSharp

curl -L -X PATCH '/manage/v2/purpose/:purposeKey' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "string",
  "authoritiesToAdd": [
    {
      "authority": "string",
      "description": "string"
    }
  ],
  "authoritiesToRemove": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

php / cURL

curl -L -X PATCH '/manage/v2/purpose/:purposeKey' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "string",
  "authoritiesToAdd": [
    {
      "authority": "string",
      "description": "string"
    }
  ],
  "authoritiesToRemove": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

java / OkHttp

curl -L -X PATCH '/manage/v2/purpose/:purposeKey' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "string",
  "authoritiesToAdd": [
    {
      "authority": "string",
      "description": "string"
    }
  ],
  "authoritiesToRemove": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

powershell / RestMethod

curl -L -X PATCH '/manage/v2/purpose/:purposeKey' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "name": "string",
  "authoritiesToAdd": [
    {
      "authority": "string",
      "description": "string"
    }
  ],
  "authoritiesToRemove": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'