Modifier les partenaires diffuseurs d'une organisation

Mettre à jour le statut d'exclusion d'une organisation pour un flux diffuseur en fournissant le (s) identifiant(s) de l'organisation souhaitant empêcher la diffusion de ses missions chez ce diffuseur.

PUT https://api.api-engagement.beta.gouv.fr/v0/myorganization/:organizationClientId

Path Parameters

Name	Type	Description
organizationClientId	String	Identifiant de l'organisation. L'identifiant doit être le même qui est utilisé dans le flux XML dans le champs organizationClientIdlors du partage des missions.

Body

Name	Type	Description
publisherIds	String[]	Liste des identifiants des partenaires qui sont autorisés a diffuser l'organisation renseignée en paramètre
organizationName	String	Optionnel - Nom de l'organisation correspondant l' organizationClientId envoyé dans les paramètres. (Si non précisé, le nom sera retrouvé a partir des missions de l'organisation s'il y en a)

Headers

Name	Type	Description
x-api-key Requis	String	La clé API nécessaire à l’authentification. Les données disponibles sont définies en fonction de votre clé API.

Response

200

/* 
PUT /v0/myorganization/mon_organisation_id_1
    body : {
        "publisherIds": [
            "parteniare_id_1",
            "parteniare_id_3"
        ],
        organizationName: "Mon organisation 1"
    }
*/
{
    "ok": true,
    "data": [
        {
            "_id": "parteniare_id_1",
            "name": "Mon partenaire diffuseur 1",
            "category": "OTHER",
            "url": "https://www.partenaire1.fr",
            "logo": "https://api-engagement-bucket.s3.fr-par.scw.cloud/publishers/parteniare_id_1/logo",
            "description": "La description de mon partenaire",
            "widget": false, // Ne diffuse pas par widget
            "api": true, // Diffuse par API
            "campaign": true, // Diffuse par campagne
            "annonceur": true, // Est annonceur de missions
            "excluded": false // L'organisation est diffusée chez ce partenaire diffuseur
        },
        {
            "_id": "parteniare_id_2",
            "name": "Mon partenaire diffuseur 2",
            "category": "PUBLICS_SERVICES",
            "url": "https://www.partenaire2.fr",
            "logo": "https://api-engagement-bucket.s3.fr-par.scw.cloud/publishers/parteniare_id_2/logo",
            "description": "La description de mon partenaire",
            "widget": true,
            "api": false,
            "campaign": true,
            "annonceur": true,
            "excluded": true // L'organisation n'est pas diffusée chez ce partenaire diffuseur
        },
        
        {
            "_id": "partenaire_id_3",
            "name": "Mon partenaire diffuseur 3",
            "category": "TERRITORIAL_COLLECTIVITIES",
            "url": "https://www.partenaire3.fr",
            "logo": "https://api-engagement-bucket.s3.fr-par.scw.cloud/publishers/parteniare_id_3/logo",
            "description": "La description de mon partenaire",
            "widget": false,
            "api": true,
            "campaign": true,
            "annonceur": false,
            "excluded": false
        },
        [...] // Pour tous les autres partenaires, excluded sera true ici
    ]
}

401 Unauthorized

Unauthorized

500 Internal Server Error

{
    "ok": false,
    "code": "SERVER_ERROR"
}