Update Automated Smart Template - This is a non incremental API, send all changes when updating, else anything which is not sent will be updated to null, empty or false.

ApiScope: manage.smarttemplate.write
API Scope Level: DealerScope

Path Parameters

dealerUUID string required

smartTemplateUuid string required

application/json

Request Body required

typeDesc string

typeName string

defaultTemplate string

templateType string

Possible values: [TEXT, EMAIL]

isSmartTemplate boolean

resourceUuid string

inSelfAdmin boolean

mandatoryTCPAFooter boolean

isFreemarkerTemplate boolean

Responses

application/json

application/x-protobuf

Schema

Example (from schema)

Schema

errors object[]

warnings object[]

apiRequestId string

uuid string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "uuid": "string"
}

Schema

Example (from schema)

Schema

errors object[]

warnings object[]

apiRequestId string

uuid string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "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"
}

PUT /v2/smartTemplates/:smartTemplateUuiddealers/:dealerUUID

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

dealerUUID — path required

smartTemplateUuid — path required

Body required

{
  "typeDesc": "string",
  "typeName": "string",
  "defaultTemplate": "string",
  "templateType": "TEXT",
  "isSmartTemplate": true,
  "resourceUuid": "string",
  "inSelfAdmin": true,
  "mandatoryTCPAFooter": true,
  "isFreemarkerTemplate": true
}

Accept

curl / cURL
curl -L -X GET '/manage' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

python / requests
curl -L -X GET '/manage' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

go / native
curl -L -X GET '/manage' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

nodejs / axios
curl -L -X GET '/manage' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

ruby / Net::HTTP
curl -L -X GET '/manage' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

csharp / RestSharp
curl -L -X GET '/manage' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

php / cURL
curl -L -X GET '/manage' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

java / OkHttp
curl -L -X GET '/manage' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

powershell / RestMethod
curl -L -X GET '/manage' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'