Chilkat Online Tools

delphiAx / Braze Endpoints / List Available Content Blocks

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;

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

http := TChilkatHttp.Create(Self);

queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('modified_after','2020-01-01T01:01:01.000000');
queryParams.UpdateString('modified_before','2020-02-01T01:01:01.000000');
queryParams.UpdateInt('limit',100);
queryParams.UpdateInt('offset',1);

// Adds the "Authorization: Bearer {{api_key}}" header.
http.AuthToken := '{{api_key}}';

resp := http.QuickRequestParams('GET','https://rest.iad-01.braze.com/content_blocks/list',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add(IntToStr(resp.StatusCode));
Memo1.Lines.Add(resp.BodyStr);

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Available Content Blocks",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{api_key}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://{{instance_url}}/content_blocks/list?modified_after=2020-01-01T01:01:01.000000&modified_before=2020-02-01T01:01:01.000000&limit=100&offset=1",
      "protocol": "https",
      "host": [
        "{{instance_url}}"
      ],
      "path": [
        "content_blocks",
        "list"
      ],
      "query": [
        {
          "key": "modified_after",
          "value": "2020-01-01T01:01:01.000000",
          "description": "(Optional) String in ISO 8601\n\nRetrieve only content blocks 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 content blocks updated at or before the given time."
        },
        {
          "key": "limit",
          "value": "100",
          "description": "(Optional) Positive Number\n\nMaximum number of content blocks to retrieve, default to 100 if not provided, maximum acceptable value is 1000."
        },
        {
          "key": "offset",
          "value": "1",
          "description": "(Optional) Positive Number\n\nNumber of content blocks to skip before returning rest of the templates that fit the search criteria."
        }
      ]
    },
    "description": "This endpoint will list existing Content Block information.\n\n### Successful Response Properties\n```json\nContent-Type: application/json\nAuthorization: Bearer YOUR_REST_API_KEY\n{\n  \"count\": \"integer\",\n  \"content_blocks\": [\n    {\n      \"content_block_id\": \"string\",\n      \"name\": \"string\",\n      \"content_type\": \"html or text\",\n      \"liquid_tag\": \"string\",\n      \"inclusion_count\" : \"integer\",\n      \"created_at\": \"time-in-iso\",\n      \"last_edited\": \"time-in-iso\",\n      \"tags\" : \"array of strings\"\n    }\n  ]\n}\n```\n\n### Possible Errors\n- `Modified after time is invalid.`\nThe date you have provided is not a valid or parsable date. Please reformat this value as a string in ISO 8601 format (`yyyy-mm-ddThh:mm:ss.ffffff`).\n\n- `Modified before time is invalid.`\nThe date you have provided is not a valid or parsable date. Please reformat this value as a string in ISO 8601 format (`yyyy-mm-ddThh:mm:ss.ffffff`).\n\n- `Modified after time must be earlier than or the same as modified before time.`\n\n- `Content Block number limit is invalid.`\nThe `limit` parameter must be an integer (positive number) greater than 0.\n\n- `Content Block number limit must be greater than 0.`\nThe `limit` parameter must be an integer (positive number) greater than 0.\n\n- `Content Block number limit exceeds maximum of 1000.`\nThe `limit` parameter must be an integer (positive number) greater than 0.\n\n- `Offset is invalid.`\nThe `offset` parameter must be an integer (positive number) greater than 0.\n\n- `Offset must be greater than 0.`\nThe `offset` parameter must be an integer (positive number) greater than 0."
  },
  "response": [
  ]
}