create a new dealer associate group purpose type

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

application/json

Request Body required

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[]

Responses

application/json

application/x-protobuf

Schema

Example (from schema)

Schema

errors object[]

warnings object[]

apiRequestId string

purposeDto object

{
  "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[]

warnings object[]

apiRequestId string

purposeDto object

{
  "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[]

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/purpose

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

Body required

{
  "key": "string",
  "name": "string",
  "authorities": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}

Accept

curl / cURL
curl -L -X POST '/manage/v2/purpose' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "key": "string",
  "name": "string",
  "authorities": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

python / requests
curl -L -X POST '/manage/v2/purpose' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "key": "string",
  "name": "string",
  "authorities": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

go / native
curl -L -X POST '/manage/v2/purpose' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "key": "string",
  "name": "string",
  "authorities": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

nodejs / axios
curl -L -X POST '/manage/v2/purpose' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "key": "string",
  "name": "string",
  "authorities": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

ruby / Net::HTTP
curl -L -X POST '/manage/v2/purpose' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "key": "string",
  "name": "string",
  "authorities": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

csharp / RestSharp
curl -L -X POST '/manage/v2/purpose' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "key": "string",
  "name": "string",
  "authorities": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

php / cURL
curl -L -X POST '/manage/v2/purpose' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "key": "string",
  "name": "string",
  "authorities": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

java / OkHttp
curl -L -X POST '/manage/v2/purpose' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "key": "string",
  "name": "string",
  "authorities": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'

powershell / RestMethod
curl -L -X POST '/manage/v2/purpose' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "key": "string",
  "name": "string",
  "authorities": [
    {
      "authority": "string",
      "description": "string"
    }
  ]
}'