Utilisateurs

Mettre à jour un dashboard personnalisé du sujet délégué

Exige une allowlist explicite sur la clé et la capacité custom_dashboards.

Scope requis : users:write. Scopes et délégation.

Délégation utilisateur : exactement un header X-Marko-Delegated-User-Id ou X-Marko-Delegated-User-Email.

Accès complémentaire : allowlist utilisateur explicite sur la clé et capacité custom_dashboards. Le sujet doit être approuvé et appartenir à la même entité.

curl --request PUT \
  --url https://partner-api.marko.fr/v1/users/me/custom-dashboards/{dashboard_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Pilotage portefeuille v2",
  "is_shared": false
}
'

import requests

url = "https://partner-api.marko.fr/v1/users/me/custom-dashboards/{dashboard_id}"

payload = {
    "name": "Pilotage portefeuille v2",
    "is_shared": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const url = 'https://partner-api.marko.fr/v1/users/me/custom-dashboards/{dashboard_id}';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Pilotage portefeuille v2', is_shared: false})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Pilotage portefeuille v2', is_shared: false})
};

fetch('https://partner-api.marko.fr/v1/users/me/custom-dashboards/{dashboard_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://partner-api.marko.fr/v1/users/me/custom-dashboards/{dashboard_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Pilotage portefeuille v2',
    'is_shared' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "resource_type": "custom_dashboard",
  "resource_id": "22222222-2222-2222-2222-222222222222",
  "status": "updated"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "type": "about:blank",
  "request_id": "<string>",
  "scope": "<string>",
  "route_id": "<string>",
  "reason_code": "<string>"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer token is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not allow this operation.",
  "request_id": "req_example_partner_call"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "type": "about:blank",
  "request_id": "<string>",
  "scope": "<string>",
  "route_id": "<string>",
  "reason_code": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "type": "about:blank",
  "request_id": "<string>",
  "scope": "<string>",
  "route_id": "<string>",
  "reason_code": "<string>"
}

{
  "type": "about:blank",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request rate limit was exceeded.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected server error occurred.",
  "request_id": "req_example_partner_call"
}

Authorizations

Authorization

string

header

required

Use the access_token returned by POST /v1/auth/token. Do not send the raw API secret on business endpoints.

Headers

X-Request-ID

string

Partner-generated correlation identifier echoed in logs and error payloads.

X-Marko-Delegated-User-Id

string

Fournir exactement un des deux headers de délégation (Id ou Email), dans la même entité. Ils sont mutuellement exclusifs. Voir le guide Scopes et délégation.

X-Marko-Delegated-User-Email

string

Fournir exactement un des deux headers de délégation (Id ou Email), dans la même entité. Ils sont mutuellement exclusifs. Voir le guide Scopes et délégation.

Path Parameters

dashboard_id

string<uuid>

required

Paramètre dashboard_id pour cette route; type, format et contraintes ci-dessous.

Body

application/json

name

string | null

Nom de la ressource. Les recherches exactes et partielles sont décrites au niveau de la route.

Required string length: 1 - 200

description

string | null

Description libre de la ressource.

Maximum string length: 2000

layout

Layout · object[] | null

Disposition des widgets du dashboard.

Maximum array length: 50

filters

Filters · object | null

Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint.

default_scope

DashboardScope · object | null

Périmètre métier initial du dashboard.

Show child attributes

is_shared

boolean | null

Indique si le dashboard est partagé.

expected_updated_at

string<date-time> | null

Valeur updated_at lue avant la modification. Une version concurrente exige une nouvelle lecture et une réévaluation.

Response

Successful response

Delegated-user asset receipt without saved filters, layout or tokens.

resource_type

enum<string>

required

Type de ressource utilisateur écrite: vue enregistrée ou tableau de bord.

Available options:

saved_view,

custom_dashboard

resource_id

string<uuid>

required

UUID de la vue ou du tableau de bord écrit.

status

enum<string>

required

Résultat de l'écriture: créé ou mis à jour.

Available options:

created,

updated

Mettre à jour un dashboard personnalisé du sujet délégué

curl --request PUT \
  --url https://partner-api.marko.fr/v1/users/me/custom-dashboards/{dashboard_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Pilotage portefeuille v2",
  "is_shared": false
}
'

import requests

url = "https://partner-api.marko.fr/v1/users/me/custom-dashboards/{dashboard_id}"

payload = {
    "name": "Pilotage portefeuille v2",
    "is_shared": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const url = 'https://partner-api.marko.fr/v1/users/me/custom-dashboards/{dashboard_id}';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Pilotage portefeuille v2', is_shared: false})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Pilotage portefeuille v2', is_shared: false})
};

fetch('https://partner-api.marko.fr/v1/users/me/custom-dashboards/{dashboard_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://partner-api.marko.fr/v1/users/me/custom-dashboards/{dashboard_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Pilotage portefeuille v2',
    'is_shared' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "resource_type": "custom_dashboard",
  "resource_id": "22222222-2222-2222-2222-222222222222",
  "status": "updated"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "type": "about:blank",
  "request_id": "<string>",
  "scope": "<string>",
  "route_id": "<string>",
  "reason_code": "<string>"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer token is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not allow this operation.",
  "request_id": "req_example_partner_call"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "type": "about:blank",
  "request_id": "<string>",
  "scope": "<string>",
  "route_id": "<string>",
  "reason_code": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "type": "about:blank",
  "request_id": "<string>",
  "scope": "<string>",
  "route_id": "<string>",
  "reason_code": "<string>"
}

{
  "type": "about:blank",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request rate limit was exceeded.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected server error occurred.",
  "request_id": "req_example_partner_call"
}

Démarrer

Tutoriels

Intégrer

Référence API

Mettre à jour un dashboard personnalisé du sujet délégué

Authorizations

Headers

Path Parameters

Body

Response