Modifier les partenaires diffuseurs d'une organisation

Met à jour les partenaires diffuseurs associés à une organisation.

Gérer les exclusions de diffusion d'une organisation

put

https://api.api-engagement.beta.gouv.frhttps://api.bac-a-sable.api-engagement.beta.gouv.frhttp://localhost:3002

/v0/myorganization/{organizationClientId}

Définit la liste des partenaires diffuseurs autorisés pour une organisation. Les partenaires non inclus dans "publisherIds" seront exclus de la diffusion.

Attention : cette opération remplace intégralement les exclusions existantes.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Clé API fournie par l'équipe API Engagement

Path parameters

organizationClientIdstringRequired

Identifiant de l'organisation dans votre système

Example: org-croix-rouge-001

Body

application/json

organizationNamestring · nullableOptional

Nom de l'organisation (optionnel, mis à jour si fourni)

Example: Croix-Rouge française

publisherIdsstring[]Required

Liste des identifiants des partenaires autorisés à diffuser les missions de cette organisation

Example: ["5f5931496c7ea514150a818f","60a1b2c3d4e5f6789abc0001"]

Responses

200

Exclusions mises à jour

application/json

okbooleanOptionalExample: true

totalintegerOptionalExample: 8

400

Paramètres invalides

application/json

401

Clé API manquante ou invalide

application/json

put

/v0/myorganization/{organizationClientId}

HTTPcURLJavaScriptPython

PUT /v0/myorganization/{organizationClientId} HTTP/1.1
Host: api.api-engagement.beta.gouv.fr
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "organizationName": "Croix-Rouge française",
  "publisherIds": [
    "5f5931496c7ea514150a818f",
    "60a1b2c3d4e5f6789abc0001"
  ]
}

{
  "ok": true,
  "total": 8,
  "data": [
    {
      "_id": "5f5931496c7ea514150a818f",
      "name": "JeVeuxAider.gouv.fr",
      "category": "Plateforme gouvernementale",
      "url": "https://www.jeveuxaider.gouv.fr",
      "description": "La plateforme officielle du bénévolat en France",
      "widget": true,
      "api": true,
      "campaign": false,
      "annonceur": false,
      "excluded": true,
      "clicks": 1
    }
  ]
}