createTemplate

Click to copy

Create a new template

Create a new template. The adminBasic or adminAdvanced privilege is required.

Request:

ParameterDescriptionData Type
templateTypeRequired. The type of template you will create. Create an email template by entering 'email', a Web Request Template by entering 'webRequest', or a Step Template by entering 'step'. Or, enter your own value to define a custom template.String

Body:

ParameterDescriptionData Type
templateIdOptional. The ID of the new template to be defined.String
templateNameRequired. The name of the new template. Case sensitive.String
templateDetailsRequired. Information to be stored in the template.String

Body parameter

Use dark colors for code blocksCopy
1
2
3
4
5
{
  "templateId": "string",
  "templateName": "string",
  "templateDetails": "string"
}

Query parameters

NameTypeRequired

token

string

Path parameters

NameTypeRequired

templateType

string

orgId

string

itemId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
5
# You can also use wget
curl -X POST /{orgId}/{itemId}/templates/{templateType} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

Use dark colors for code blocksCopy
1
2
3
{
  "templateId": "string"
}
StatusMeaningDescriptionSchema

200

OK

success

Inline

500

Internal Server Error

error

WorkflowJsonExceptionDTO

Response details

Status Code 200

CreateTemplateResponse

NameTypeRequired

templateId

string

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.