Chilkat Online Tools

Objective-C / Braze Endpoints / See Content Block Information

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"content_block_id" value: @"{{content_block_id}}"];
[queryParams UpdateString: @"include_inclusion_data" value: @"No"];

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

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://rest.iad-01.braze.com/content_blocks/info" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

Curl Command

curl -G -d "content_block_id=%7B%7Bcontent_block_id%7D%7D"
	-d "include_inclusion_data=No"
	-H "Authorization: Bearer {{api_key}}"
https://rest.iad-01.braze.com/content_blocks/info

Postman Collection Item JSON

{
  "name": "See Content Block Information",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{api_key}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://{{instance_url}}/content_blocks/info?content_block_id={{content_block_id}}&include_inclusion_data=No",
      "protocol": "https",
      "host": [
        "{{instance_url}}"
      ],
      "path": [
        "content_blocks",
        "info"
      ],
      "query": [
        {
          "key": "content_block_id",
          "value": "{{content_block_id}}",
          "description": "(Required) String\n\nThe Content Block ID. This can be found by either listing Content Block information or going to the Developer Console, then API Settings, then scrolling to the bottom and searching for your Content Block API Identifier."
        },
        {
          "key": "include_inclusion_data",
          "value": "No",
          "description": "(Optional) Boolean\n\nWhen set to ‘true’, the API returns back the Message Variation API ID of Campaigns and Canvases where this content block is included, to be used in subsequent calls. The results exclude archived or deleted Campaigns or Canvases."
        }
      ]
    },
    "description": "This endpoint will call information for an existing Content Block.\n\n### Successful Response Properties\n```json\nContent-Type: application/json\nAuthorization: Bearer YOUR_REST_API_KEY\n{\n  \"content_block_id\": \"string\",\n  \"name\": \"string\",\n  \"content\": \"string\",\n  \"description\": \"string\",\n  \"content_type\": \"html or text\",\n  \"tags\":  \"array of strings\",\n  \"created_at\": \"time-in-iso\",\n  \"last_edited\": \"time-in-iso\",\n  \"inclusion_count\" : \"integer\",\n  \"message\": \"success\"\n}\n```\n\n### Possible Errors\n- `Content Block ID cannot be blank.` - A Content Block has not been listed or is not encapsulated in quotes.\n\n- `Content Block ID is invalid for this App Group.` - This Content Block does not exist or is in a different company account or app group.\n\n- `Content Block has been deleted - content not available.` - This Content Block, though it may have existed earlier, has been deleted.\n\n- `Include Inclusion Data - error` - One of true or false is not provided."
  },
  "response": [
  ]
}