Chilkat Online Tools

lianja / Salesforce Platform APIs / Consent

Back to Collection Items

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

loHttp = createobject("CkHttp")

loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("actions","")
loQueryParams.UpdateString("ids","")

// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")

loResp = loHttp.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/consent/action/action",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loQueryParams
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loQueryParams

Curl Command

curl -G -d "actions="
	-d "ids="
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/consent/action/action

Postman Collection Item JSON

{
  "name": "Consent",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/consent/action/action?actions&ids",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "consent",
        "action",
        "action"
      ],
      "query": [
        {
          "key": "aggregatedConsent",
          "value": "",
          "description": "Optional: true or false. aggregatedConsent is the same as aggregatedConsent=true. If true, one result is returned indicating whether to proceed or not, rather than a result for each ID. If any ID in the list returns false, the aggregated result is false.",
          "disabled": true
        },
        {
          "key": "datetime",
          "value": "",
          "description": "Optional. The timestamp for which consent is determined. The value is converted to the UTC timezone and must be specified in ISO 8601 format. If not specified, defaults to the current date and time.",
          "disabled": true
        },
        {
          "key": "purpose",
          "value": "",
          "description": "Optional. The reason for contacting a customer.",
          "disabled": true
        },
        {
          "key": "verbose",
          "value": "",
          "description": "Optional: true or false. verbose is the same as verbose=true. Verbose responses are slower than non-verbose responses. See the examples for a verbose response.",
          "disabled": true
        },
        {
          "key": "actions",
          "value": null
        },
        {
          "key": "ids",
          "value": null
        }
      ]
    },
    "description": "Your users can store consent preferences in different locations and possibly inconsistently. You can locate your customers’ preferences for consent across multiple records when using API version 44.0 and later. Tracking consent preferences helps you and your users respect the most restrictive requests.\nConsent API aggregates consent settings across the Contact, Contact Point Type Consent, Data Use Purpose, Individual, Lead, Person Account, and User objects when the records have a lookup relationship. The Consent API can't locate records in which the email address field is protected by Platform Encryption.\n\nThe API returns consent details based on a single action, like email or track, or—starting with API version 45.0—the multiaction endpoint allows you to request multiple actions in a single API call."
  },
  "response": [
  ]
}