Consent

curl -X POST https://api-catalog.nucleoplatform.com/api/collect/v1/consent \
  -H "X-Nucleo-Key: $NUCLEO_COLLECTOR_KEY" \
  -H 'Origin: https://shop.acme.example' \
  -H 'Content-Type: text/plain' \
  -d '{
  "visitor": {
    "id": "8b1f0c2e9d7a4b3c6e5f1a2b3c4d5e6f",
    "consentSource": "shopify"
  },
  "consent": "revoked",
  "purposes": []
}'

const res = await fetch("https://api-catalog.nucleoplatform.com/api/collect/v1/consent", {
  method: "POST",
  headers: {
    "X-Nucleo-Key": `${process.env.NUCLEO_COLLECTOR_KEY}`,
    Origin: "https://shop.acme.example",
    "Content-Type": "text/plain",
  },
  body: JSON.stringify({
    "visitor": {
      "id": "8b1f0c2e9d7a4b3c6e5f1a2b3c4d5e6f",
      "consentSource": "shopify"
    },
    "consent": "revoked",
    "purposes": []
  }),
});
const data = await res.json();
console.log(res.status, data);

<?php

require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

$response = $client->request('POST', 'https://api-catalog.nucleoplatform.com/api/collect/v1/consent', [
    'headers' => [
        'X-Nucleo-Key' => getenv('NUCLEO_COLLECTOR_KEY'),
        'Origin' => 'https://shop.acme.example',
        'Content-Type' => 'text/plain',
    ],
    'json' => [
        'visitor' => [
            'id' => '8b1f0c2e9d7a4b3c6e5f1a2b3c4d5e6f',
            'consentSource' => 'shopify',
        ],
        'consent' => 'revoked',
        'purposes' => [],
    ],
    'http_errors' => false,
]);

echo $response->getStatusCode(), PHP_EOL;
echo $response->getBody();

{
  "visitor": "8b1f0c2e9d7a4b3c6e5f1a2b3c4d5e6f",
  "consent": "granted",
  "stored": true,
  "counted": true
}

{
  "visitor": "8b1f0c2e9d7a4b3c6e5f1a2b3c4d5e6f",
  "consent": "revoked",
  "deleted": {
    "events": 57,
    "identities": 1,
    "carts": 2
  },
  "counted": true
}

{
  "visitor": "8b1f0c2e9d7a4b3c6e5f1a2b3c4d5e6f",
  "consent": "denied",
  "stored": false,
  "counted": true
}

{
  "visitor": null,
  "consent": "denied",
  "stored": false,
  "counted": true
}

{
  "visitor": "8b1f0c2e9d7a4b3c6e5f1a2b3c4d5e6f",
  "consent": "pending",
  "stored": false,
  "counted": false
}

{
  "visitor": "8b1f0c2e9d7a4b3c6e5f1a2b3c4d5e6f",
  "consent": "granted",
  "stored": false,
  "counted": false,
  "test": true,
  "testKnown": false
}

{
  "message": "Forbidden."
}

{
  "message": "Not found."
}

{
  "message": "Store is not ready."
}

{
  "message": "Payload too large."
}

{
  "message": "The consent update is not valid.",
  "errors": {
    "visitor.id": "visitor.id is required to grant consent: 16-64 characters of [A-Za-z0-9_-]."
  }
}

{
  "message": "The consent update is not valid.",
  "errors": {
    "consent": "consent must be one of: granted, denied, pending, revoked."
  }
}

{
  "message": "The consent update is not valid.",
  "errors": {
    "visitor.id": "visitor.id must be 16-64 characters of [A-Za-z0-9_-]."
  }
}

{
  "message": "Too Many Attempts."
}