Chilkat Online Tools

PureBasic / Braze Endpoints / List Available Email Templates

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    queryParams.i = CkJsonObject::ckCreate()
    If queryParams.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(queryParams,"modified_after","2020-01-01T01:01:01.000000")
    CkJsonObject::ckUpdateString(queryParams,"modified_before","2020-02-01T01:01:01.000000")
    CkJsonObject::ckUpdateInt(queryParams,"limit",1)
    CkJsonObject::ckUpdateInt(queryParams,"offset",0)

    ; Adds the "Authorization: Bearer {{api_key}}" header.
    CkHttp::setCkAuthToken(http, "{{api_key}}")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://rest.iad-01.braze.com/templates/email/list",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)


    ProcedureReturn
EndProcedure

Curl Command

curl -G -d "modified_after=2020-01-01T01%3A01%3A01.000000"
	-d "modified_before=2020-02-01T01%3A01%3A01.000000"
	-d "limit=1"
	-d "offset=0"
	-H "Authorization: Bearer {{api_key}}"
https://rest.iad-01.braze.com/templates/email/list

Postman Collection Item JSON

{
  "name": "List Available Email Templates",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{api_key}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://{{instance_url}}/templates/email/list?modified_after=2020-01-01T01:01:01.000000&modified_before=2020-02-01T01:01:01.000000&limit=1&offset=0",
      "protocol": "https",
      "host": [
        "{{instance_url}}"
      ],
      "path": [
        "templates",
        "email",
        "list"
      ],
      "query": [
        {
          "key": "modified_after",
          "value": "2020-01-01T01:01:01.000000",
          "description": "(Optional) String in ISO 8601\n\nRetrieve only templates updated at or after the given time."
        },
        {
          "key": "modified_before",
          "value": "2020-02-01T01:01:01.000000",
          "description": "(Optional) String in ISO 8601\n\nRetrieve only templates updated at or before the given time"
        },
        {
          "key": "limit",
          "value": "1",
          "description": "(Optional) Positive Number\n\nMaximum number of templates to retrieve, default to 100 if not provided, maximum acceptable value is 1000."
        },
        {
          "key": "offset",
          "value": "0",
          "description": "(Optional) Positive Number\n\nNumber of templates to skip before returning rest of the templates that fit the search criteria."
        }
      ]
    },
    "description": "Use this endpoint to get a list of available templates in your Braze account.\n\nUse the Template REST APIs to programmatically manage the email templates that you have stored on the Braze dashboard, on the Templates & Media page. Braze provides two endpoints for creating and updating your email templates.\n\n### Successful Response Properties\n```json\n{\n  \"count\": number of templates returned\n  \"templates\": [template with the following properties]:\n    \"email_template_id\": (string) your email template's API Identifier,\n    \"template_name\": (string) the name of your email template,\n    \"created_at\": (string, in ISO 8601),\n    \"updated_at\": (string, in ISO 8601),\n    \"tags\": (array of strings) tags appended to the template\n}\n  ```"
  },
  "response": [
  ]
}