Créer / mettre à jour une mission
Crée une nouvelle mission ou met à jour une mission existante via son identifiant client.
Crée une nouvelle mission pour votre organisation.
La mission est immédiatement soumise aux règles de modération automatique : si elle est incomplète (description trop courte, pas d'adresse, etc.), le champ "statusCode" sera positionné à "REFUSED" avec un commentaire explicatif.
Rate limiting : endpoint soumis à limitation de débit.
Clé API fournie par l'équipe API Engagement
Identifiant unique de la mission dans votre système d'information (immuable)
mission-2024-001Titre de la mission
Animateur bénévole en maison de retraiteDescription complète de la mission. Texte brut ou HTML acceptés.
La valeur fournie est conservée pour le rendu riche. Si du HTML est fourni, elle est aussi convertie en texte brut pour les usages internes, la recherche et la modération.
Recommandations :
- Utiliser le format HTML pour une meilleure lisibilité lors de la diffusion (sauts de ligne, gras, listes)
- Structurer en plusieurs sections pour agréger des informations provenant de champs différents dans votre système
- La description est limitée à 20 000 caractères
<p><strong>EN QUELQUES MOTS</strong></p><p>Favoriser la mixité au sein du club</p><p><strong>VOTRE MISSION DE SERVICE CIVIQUE</strong></p><p><u>Objectifs</u></p><ul><li>Développer la féminisation et favoriser l'accès à la pratique du football des jeunes filles</li></ul><p><u>Actions</u></p><ul><li>Accompagner les éducateurs dans le projet éducatif féminin</li><li>Mettre en place des actions en faveur de la mixité</li><li>Sensibiliser les jeunes filles éloignées de la pratique sportive</li></ul>URL de la page où l'utilisateur sera redirigé pour candidater (URL de la page présentant la mission)
https://www.example.org/missions/animateur-maison-retraiteURL de l'image de la mission. Si absent, l'API Engagement utilise une image de sa bibliothèque selon le domaine.
Métadonnées libres associées à la mission.
Domaine d'action de la mission. Valeurs possibles :
animaux, autre, batiment-industrie-logistique, benevolat-competences, communication, culture-loisirs, education, emploi, environnement, gestion-finance-droit, humanitaire, memoire-et-citoyennete, numerique, prevention-protection, recherche, sante, service-public-defense-securite, sport, solidarite-insertion, vivre-ensemble.
Une demande d'ajout de valeur peut être faite auprès de l'équipe API Engagement.
santeActivité(s) principale(s) de la mission. Valeurs possibles :
accueil-de-public, aide-psychologique, activites-manuelles, alphabetisation, animation, Animation, Valorisation, art, autre, bricolage, collecte, communication, comptabilite-finance, conseil, distribution, documentation-traduction, ecoute-permanence, encadrement-d-equipes, enseignement-formation, gestion-de-projets, gestion-recherche-des-partenariats, informatique, jardinage, juridique, logistique, lutte-contre-isolement, Médiation, Information, mentorat-parrainage, mission-internationale, Préservation, Patrimoine, Prévention, Sensibilisation, ramassage-dechets, recrutement, responsabilites-associatives, sante-soins, Secours, Aide, secourisme, sensibilisation, soins-animaux, Soutien, Accompagnement, soutien-scolaire, sport, taches-administratives, Transmission, Pédagogie, visites, operations-militaires, sciences-humaines-social, restauration-hotellerie, maintenance-technique, gestion-ressources-humaines, gestion-entretien-patrimoine.
Une demande d'ajout de valeur peut être faite auprès de l'équipe API Engagement.
["animation","lutte-contre-isolement"]Mots-clés personnalisés pour taguer la mission. Chaque élément du tableau est un tag distinct.
["Ecologie","Sport","Solidarité"]Les bénéficiaires de la mission — à qui la mission s'adresse, le public auquel sera confronté la personne qui s'engage.
["Tous publics"]Pré-requis relatifs à la mission.
["Niveau d'étude : BAC+2","Connaissance de langue anglaise"]Les compétences générales requises pour la mission. Ce champ ne repose pas sur un référentiel de compétence structuré.
["Écoute active","Communication orale"]Code OGR Macro du ROME 4.0. Ce champ repose sur le référentiel "Arborescence simplifiée des compétences" (section "Arborescence du ROME").
["300412","300361"]Disponibilité en distanciel. Valeurs possibles : no (présentiel uniquement), possible (distanciel possible), full (100% distanciel)
noPossible values: Rythme de la mission (texte libre)
2 heures par semaineDate de début de la mission souhaitée. Format ISO 8601. Défaut : now()
2024-09-01T00:00:00.000ZDate de fin de la mission souhaitée. Format ISO 8601. Défaut : now()
2025-06-30T00:00:00.000ZDate de première publication de la mission. Format ISO 8601.
2024-06-15T09:00:00.000ZNombre de places disponibles pour la mission. Ce nombre doit être mis à jour dès qu'il évolue dans votre système afin que l'API Engagement dispose toujours de la donnée la plus récente.
1Montant minimum de l'indemnisation. Utilisé seul ou comme borne basse d'une fourchette avec compensationAmountMax.
0Montant maximum de l'indemnisation. Si renseigné, doit être supérieur ou égal à compensationAmount (ex. 0–13 €/h).
13Période de l'indemnisation pour le montant fourni. Valeurs possibles : year, month, day, hour
Type d'indemnisation. Valeurs possibles : gross (brut), net (net)
Mission ouverte aux mineurs.
Mission accessible aux personnes à mobilité réduite.
Mission proche des transports en commun.
Type de mission d'engagement
Identifiant de l'organisation dans votre système. L'organisation désigne l'entité qui accueille le bénévole ou le volontaire.
Nom de l'organisation. Requis si un autre champ organization* est renseigné.
Description de l'organisation.
Lien de l'organisation (ex. page de présentation sur votre site).
Type de l'organisation.
Association déclaréeURL de l'image de l'organisation.
Numéro RNA de l'organisation. Uniquement valable pour les organisations de type association.
W353002476SIREN de l'organisation.
339863417SIRET de l'organisation.
33986341700418Adresse de l'organisation. Pas de format strict attendu (contrairement à l'adresse de la mission).
Code postal de l'organisation.
94170Ville de l'organisation.
Le Perreux-sur-MarneCode du département de l'organisation.
94Nom du département de l'organisation.
Val de MarneStatut juridique de l'organisation.
Bénéficiaires de l'organisation.
Principales actions menées par l'organisation.
["Animation","Valorisation","Préservation"]Réseau de l'organisation. Ce champ sert à renseigner les organisations ayant des antennes locales et dépendant d'un réseau national.
Mission créée
trueParamètres invalides
Clé API manquante ou invalide
Conflit — la ressource existe déjà
Limite de débit atteinte
POST /v2/mission HTTP/1.1
Host: api.api-engagement.beta.gouv.fr
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2251
{
"clientId": "mission-2024-001",
"title": "Animateur bénévole en maison de retraite",
"description": "<p><strong>EN QUELQUES MOTS</strong></p><p>Favoriser la mixité au sein du club</p><p><strong>VOTRE MISSION DE SERVICE CIVIQUE</strong></p><p><u>Objectifs</u></p><ul><li>Développer la féminisation et favoriser l'accès à la pratique du football des jeunes filles</li></ul><p><u>Actions</u></p><ul><li>Accompagner les éducateurs dans le projet éducatif féminin</li><li>Mettre en place des actions en faveur de la mixité</li><li>Sensibiliser les jeunes filles éloignées de la pratique sportive</li></ul>",
"applicationUrl": "https://www.example.org/missions/animateur-maison-retraite",
"image": "https://example.com",
"metadata": "text",
"domain": "sante",
"activities": [
"animation",
"lutte-contre-isolement"
],
"tags": [
"Ecologie",
"Sport",
"Solidarité"
],
"audience": [
"Tous publics"
],
"requirements": [
"Niveau d'étude : BAC+2",
"Connaissance de langue anglaise"
],
"softSkills": [
"Écoute active",
"Communication orale"
],
"romeSkills": [
"300412",
"300361"
],
"remote": "no",
"schedule": "2 heures par semaine",
"startAt": "2024-09-01T00:00:00.000Z",
"endAt": "2025-06-30T00:00:00.000Z",
"postedAt": "2024-06-15T09:00:00.000Z",
"places": 1,
"compensationAmount": 0,
"compensationAmountMax": 13,
"compensationUnit": "hour",
"compensationType": "gross",
"openToMinors": true,
"reducedMobilityAccessible": true,
"closeToTransport": true,
"addresses": [
{
"street": "12 rue de la Paix",
"postalCode": "75001",
"city": "Paris",
"departmentCode": "75",
"departmentName": "Paris",
"region": "Île-de-France",
"country": "France"
}
],
"type": "benevolat",
"organizationClientId": "text",
"organizationName": "text",
"organizationDescription": "text",
"organizationUrl": "https://example.com",
"organizationType": "Association déclarée",
"organizationLogo": "https://example.com",
"organizationRNA": "W353002476",
"organizationSiren": "339863417",
"organizationSiret": "33986341700418",
"organizationFullAddress": "text",
"organizationPostCode": "94170",
"organizationCity": "Le Perreux-sur-Marne",
"organizationDepartmentCode": "94",
"organizationDepartmentName": "Val de Marne",
"organizationStatusJuridique": "text",
"organizationBeneficiaries": [
"text"
],
"organizationActions": [
"Animation",
"Valorisation",
"Préservation"
],
"organizationReseaux": [
"text"
]
}{
"ok": true,
"data": {
"id": "64a1b2c3d4e5f6789abc0001",
"clientId": "mission-bénévolat-2024-001",
"publisherId": "5f5931496c7ea514150a818f",
"statusCode": "ACCEPTED",
"title": "Animateur bénévole en maison de retraite",
"applicationUrl": "https://example.org/missions/001/postuler",
"domain": "sante",
"activities": [
"animation",
"accompagnement"
],
"audience": [
"seniors",
"personnes-isolees"
],
"remote": "no",
"schedule": "2 heures par semaine le samedi matin",
"places": 5,
"openToMinors": true,
"reducedMobilityAccessible": true,
"addresses": [
{
"street": "12 rue de la Paix",
"zip": "75001",
"city": "Paris",
"department": "75",
"departmentName": "Paris",
"region": "Île-de-France",
"country": "France",
"location": {
"lat": 48.8698,
"lon": 2.3303
}
}
],
"organizationName": "Croix-Rouge française",
"organizationRNA": "W751206979",
"organizationSiren": "775672272",
"organizationSiret": "77567227221138",
"organizationUrl": "https://www.croix-rouge.fr",
"createdAt": "2024-01-15T09:00:00.000Z",
"updatedAt": "2024-03-01T14:30:00.000Z",
"closeToTransport": true
}
}Mise à jour partielle d'une mission (sémantique PATCH). Seuls les champs fournis dans le corps sont modifiés. Les règles de modération automatique sont réévaluées sur l'état complet résultant.
Rate limiting : endpoint soumis à limitation de débit.
Clé API fournie par l'équipe API Engagement
Identifiant de la mission dans votre système
mission-2024-001Tous les champs sont optionnels — seuls les champs fournis sont mis à jour
Titre de la mission
Animateur bénévole en maison de retraiteDescription complète de la mission. Texte brut ou HTML acceptés.
La valeur fournie est conservée pour le rendu riche. Si du HTML est fourni, elle est aussi convertie en texte brut pour les usages internes, la recherche et la modération.
Recommandations :
- Utiliser le format HTML pour une meilleure lisibilité lors de la diffusion (sauts de ligne, gras, listes)
- Structurer en plusieurs sections pour agréger des informations provenant de champs différents dans votre système
- La description est limitée à 20 000 caractères
<p><strong>EN QUELQUES MOTS</strong></p><p>Favoriser la mixité au sein du club</p><p><strong>VOTRE MISSION DE SERVICE CIVIQUE</strong></p><p><u>Objectifs</u></p><ul><li>Développer la féminisation et favoriser l'accès à la pratique du football des jeunes filles</li></ul><p><u>Actions</u></p><ul><li>Accompagner les éducateurs dans le projet éducatif féminin</li><li>Mettre en place des actions en faveur de la mixité</li><li>Sensibiliser les jeunes filles éloignées de la pratique sportive</li></ul>URL de la page où l'utilisateur sera redirigé pour candidater (URL de la page présentant la mission)
https://www.example.org/missions/animateur-maison-retraiteURL de l'image de la mission. Si absent, l'API Engagement utilise une image de sa bibliothèque selon le domaine.
Métadonnées libres associées à la mission.
Domaine d'action de la mission. Valeurs possibles :
animaux, autre, batiment-industrie-logistique, benevolat-competences, communication, culture-loisirs, education, emploi, environnement, gestion-finance-droit, humanitaire, memoire-et-citoyennete, numerique, prevention-protection, recherche, sante, service-public-defense-securite, sport, solidarite-insertion, vivre-ensemble.
Une demande d'ajout de valeur peut être faite auprès de l'équipe API Engagement.
santeActivité(s) principale(s) de la mission. Valeurs possibles :
accueil-de-public, aide-psychologique, activites-manuelles, alphabetisation, animation, Animation, Valorisation, art, autre, bricolage, collecte, communication, comptabilite-finance, conseil, distribution, documentation-traduction, ecoute-permanence, encadrement-d-equipes, enseignement-formation, gestion-de-projets, gestion-recherche-des-partenariats, informatique, jardinage, juridique, logistique, lutte-contre-isolement, Médiation, Information, mentorat-parrainage, mission-internationale, Préservation, Patrimoine, Prévention, Sensibilisation, ramassage-dechets, recrutement, responsabilites-associatives, sante-soins, Secours, Aide, secourisme, sensibilisation, soins-animaux, Soutien, Accompagnement, soutien-scolaire, sport, taches-administratives, Transmission, Pédagogie, visites, operations-militaires, sciences-humaines-social, restauration-hotellerie, maintenance-technique, gestion-ressources-humaines, gestion-entretien-patrimoine.
Une demande d'ajout de valeur peut être faite auprès de l'équipe API Engagement.
["animation","lutte-contre-isolement"]Mots-clés personnalisés pour taguer la mission. Chaque élément du tableau est un tag distinct.
["Ecologie","Sport","Solidarité"]Les bénéficiaires de la mission — à qui la mission s'adresse, le public auquel sera confronté la personne qui s'engage.
["Tous publics"]Pré-requis relatifs à la mission.
["Niveau d'étude : BAC+2","Connaissance de langue anglaise"]Les compétences générales requises pour la mission. Ce champ ne repose pas sur un référentiel de compétence structuré.
["Écoute active","Communication orale"]Code OGR Macro du ROME 4.0. Ce champ repose sur le référentiel "Arborescence simplifiée des compétences" (section "Arborescence du ROME").
["300412","300361"]Disponibilité en distanciel. Valeurs possibles : no (présentiel uniquement), possible (distanciel possible), full (100% distanciel)
noPossible values: Rythme de la mission (texte libre)
2 heures par semaineDate de début de la mission souhaitée. Format ISO 8601. Défaut : now()
2024-09-01T00:00:00.000ZDate de fin de la mission souhaitée. Format ISO 8601. Défaut : now()
2025-06-30T00:00:00.000ZDate de première publication de la mission. Format ISO 8601.
2024-06-15T09:00:00.000ZMontant minimum de l'indemnisation. Utilisé seul ou comme borne basse d'une fourchette avec compensationAmountMax.
0Montant maximum de l'indemnisation. Si renseigné, doit être supérieur ou égal à compensationAmount (ex. 0–13 €/h).
13Période de l'indemnisation pour le montant fourni. Valeurs possibles : year, month, day, hour
Type d'indemnisation. Valeurs possibles : gross (brut), net (net)
Mission ouverte aux mineurs.
Mission accessible aux personnes à mobilité réduite.
Mission proche des transports en commun.
Type de mission d'engagement
Identifiant de l'organisation dans votre système. L'organisation désigne l'entité qui accueille le bénévole ou le volontaire.
Nom de l'organisation. Requis si un autre champ organization* est renseigné.
Description de l'organisation.
Lien de l'organisation (ex. page de présentation sur votre site).
Type de l'organisation.
Association déclaréeURL de l'image de l'organisation.
Numéro RNA de l'organisation. Uniquement valable pour les organisations de type association.
W353002476SIREN de l'organisation.
339863417SIRET de l'organisation.
33986341700418Adresse de l'organisation. Pas de format strict attendu (contrairement à l'adresse de la mission).
Code postal de l'organisation.
94170Ville de l'organisation.
Le Perreux-sur-MarneStatut juridique de l'organisation.
Bénéficiaires de l'organisation.
Principales actions menées par l'organisation.
["Animation","Valorisation","Préservation"]Réseau de l'organisation. Ce champ sert à renseigner les organisations ayant des antennes locales et dépendant d'un réseau national.
Mission mise à jour
trueParamètres invalides
Clé API manquante ou invalide
Ressource introuvable
Limite de débit atteinte
PUT /v2/mission/{clientId} HTTP/1.1
Host: api.api-engagement.beta.gouv.fr
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2143
{
"title": "Animateur bénévole en maison de retraite",
"description": "<p><strong>EN QUELQUES MOTS</strong></p><p>Favoriser la mixité au sein du club</p><p><strong>VOTRE MISSION DE SERVICE CIVIQUE</strong></p><p><u>Objectifs</u></p><ul><li>Développer la féminisation et favoriser l'accès à la pratique du football des jeunes filles</li></ul><p><u>Actions</u></p><ul><li>Accompagner les éducateurs dans le projet éducatif féminin</li><li>Mettre en place des actions en faveur de la mixité</li><li>Sensibiliser les jeunes filles éloignées de la pratique sportive</li></ul>",
"applicationUrl": "https://www.example.org/missions/animateur-maison-retraite",
"image": "https://example.com",
"metadata": "text",
"domain": "sante",
"activities": [
"animation",
"lutte-contre-isolement"
],
"tags": [
"Ecologie",
"Sport",
"Solidarité"
],
"audience": [
"Tous publics"
],
"requirements": [
"Niveau d'étude : BAC+2",
"Connaissance de langue anglaise"
],
"softSkills": [
"Écoute active",
"Communication orale"
],
"romeSkills": [
"300412",
"300361"
],
"remote": "no",
"schedule": "2 heures par semaine",
"startAt": "2024-09-01T00:00:00.000Z",
"endAt": "2025-06-30T00:00:00.000Z",
"postedAt": "2024-06-15T09:00:00.000Z",
"places": 1,
"compensationAmount": 0,
"compensationAmountMax": 13,
"compensationUnit": "hour",
"compensationType": "gross",
"openToMinors": true,
"reducedMobilityAccessible": true,
"closeToTransport": true,
"addresses": [
{
"street": "12 rue de la Paix",
"postalCode": "75001",
"city": "Paris",
"departmentCode": "75",
"departmentName": "Paris",
"region": "Île-de-France",
"country": "France"
}
],
"type": "benevolat",
"organizationClientId": "text",
"organizationName": "text",
"organizationDescription": "text",
"organizationUrl": "https://example.com",
"organizationType": "Association déclarée",
"organizationLogo": "https://example.com",
"organizationRNA": "W353002476",
"organizationSiren": "339863417",
"organizationSiret": "33986341700418",
"organizationFullAddress": "text",
"organizationPostCode": "94170",
"organizationCity": "Le Perreux-sur-Marne",
"organizationStatusJuridique": "text",
"organizationBeneficiaries": [
"text"
],
"organizationActions": [
"Animation",
"Valorisation",
"Préservation"
],
"organizationReseaux": [
"text"
]
}{
"ok": true,
"data": {
"id": "64a1b2c3d4e5f6789abc0001",
"clientId": "mission-bénévolat-2024-001",
"publisherId": "5f5931496c7ea514150a818f",
"statusCode": "ACCEPTED",
"title": "Animateur bénévole en maison de retraite",
"applicationUrl": "https://example.org/missions/001/postuler",
"domain": "sante",
"activities": [
"animation",
"accompagnement"
],
"audience": [
"seniors",
"personnes-isolees"
],
"remote": "no",
"schedule": "2 heures par semaine le samedi matin",
"places": 5,
"openToMinors": true,
"reducedMobilityAccessible": true,
"addresses": [
{
"street": "12 rue de la Paix",
"zip": "75001",
"city": "Paris",
"department": "75",
"departmentName": "Paris",
"region": "Île-de-France",
"country": "France",
"location": {
"lat": 48.8698,
"lon": 2.3303
}
}
],
"organizationName": "Croix-Rouge française",
"organizationRNA": "W751206979",
"organizationSiren": "775672272",
"organizationSiret": "77567227221138",
"organizationUrl": "https://www.croix-rouge.fr",
"createdAt": "2024-01-15T09:00:00.000Z",
"updatedAt": "2024-03-01T14:30:00.000Z",
"closeToTransport": true
}
}Last updated