Chilkat Online Tools

C / Braze Endpoints / List User's Subscription Group - Email

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject queryParams;
    HCkHttpResponse resp;

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

    http = CkHttp_Create();

    queryParams = CkJsonObject_Create();
    CkJsonObject_UpdateString(queryParams,"external_id","{{external_id}}");
    CkJsonObject_UpdateString(queryParams,"email","example@braze.com");
    CkJsonObject_UpdateInt(queryParams,"limit",100);
    CkJsonObject_UpdateInt(queryParams,"offset",1);

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

    resp = CkHttp_QuickRequestParams(http,"GET","https://rest.iad-01.braze.com/subscription/user/status",queryParams);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        return;
    }

    printf("%d\n",CkHttpResponse_getStatusCode(resp));
    printf("%s\n",CkHttpResponse_bodyStr(resp));
    CkHttpResponse_Dispose(resp);


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(queryParams);

    }

Curl Command

curl -G -d "external_id=%7B%7Bexternal_id%7D%7D"
	-d "email=example%40braze.com"
	-d "limit=100"
	-d "offset=1"
	-H "Authorization: Bearer {{api_key}}"
https://rest.iad-01.braze.com/subscription/user/status

Postman Collection Item JSON

{
  "name": "List User's Subscription Group - Email",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{api_key}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://{{instance_url}}/subscription/user/status?external_id={{external_id}}&email=example@braze.com&limit=100&offset=1",
      "protocol": "https",
      "host": [
        "{{instance_url}}"
      ],
      "path": [
        "subscription",
        "user",
        "status"
      ],
      "query": [
        {
          "key": "external_id",
          "value": "{{external_id}}",
          "description": "(Required) String\n\nThe external_id of the user. Must include at least one and at most 50 `external_ids`."
        },
        {
          "key": "email",
          "value": "example@braze.com",
          "description": "(Required) String\n\nThe email address of the user. Must include at least one address and at most 50 addresses. "
        },
        {
          "key": "limit",
          "value": "100",
          "description": "(Optional) Integer\n\nThe limit on the maximum number of results returned. Default (and max) limit is 100."
        },
        {
          "key": "offset",
          "value": "1",
          "description": "(Optional) Integer\n\nNumber of templates to skip before returning rest of the templates that fit the search criteria."
        }
      ]
    },
    "description": "Use the endpoint below to list and get the subscription groups of a certain user.\n\n> If there are multiple users (multiple external ids) who share the same email address, all users will be returned as a separate user (even if they have the same email address or subscription group)."
  },
  "response": [
  ]
}