Update blocked identity

Update comment and name fields on a blocked identity. Requires a Write key.

POST/identity-logs/blocked/{blockedId}

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Path parameters

blockedIdstringrequired

Request body

requiredapplication/json

commentstringrequired

min length 1

first_namestringrequired

min length 1

last_namestringrequired

min length 1

birthDatestring

Optional new birth date, same formats as on create. Omit it to keep the stored date; it cannot be cleared.

Responses

200

Updated

successbooleanrequired

400

Invalid parameters or body.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

403

API key rejected (see Forbidden), or identity logs are not enabled for the organization (Feature not available).

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

404

No item with this id.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (API key)Remember on this deviceInclude my values in samples

Parameters

blockedIdpath*

Bodyapplication/json

commentstring*first_namestring*last_namestring*birthDatestringOptional new birth date, same formats as on create. Omit it to keep the stored date; it cannot be cleared.

Request

curl -X POST 'https://dashboard.scango.ch/api/v1/identity-logs/blocked/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "comment": "Updated note",
  "first_name": "Ada",
  "last_name": "Lovelace"
}'

const response = await fetch("https://dashboard.scango.ch/api/v1/identity-logs/blocked/string", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"comment\": \"Updated note\",\n  \"first_name\": \"Ada\",\n  \"last_name\": \"Lovelace\"\n}"
});

import requests

response = requests.post(
    "https://dashboard.scango.ch/api/v1/identity-logs/blocked/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"comment\": \"Updated note\",\n  \"first_name\": \"Ada\",\n  \"last_name\": \"Lovelace\"\n}",
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/identity-logs/blocked/string',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "comment": "Updated note",
  "first_name": "Ada",
  "last_name": "Lovelace"
}',
]);

$response = curl_exec($curl);

Response

{
  "success": true
}

{
  "statusCode": 400,
  "message": "Validation failed for Field: name, Error: Required",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/suppliers"
}

{
  "statusCode": 403,
  "message": "Feature not available",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/identity-logs"
}

{
  "statusCode": 0,
  "message": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "path": "string"
}