Qualifier une candidature

Une candidature trackée via l'implémentation du JSTag peut être qualifiée a posteriori, en utilisant son ID "client" ou celui interne à l'API Engagement.

400

{
    "ok": false,
    "code": "INVALID_BODY",
    "error": [
        {
            "expected": "string",
            "code": "invalid_type",
            "path": [
                "clickId"
            ],
            "message": "Invalid input: expected string, received undefined"
        }
    ]
}

404

1. Mettre à jour le status de la candidature

PUT https://api.api-engagement.beta.gouv.fr/v2/activity/:id

Il est possible de mettre à jour le statut d'une candidature afin de suivre l'avancement du candidat.

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.

Params

Name	Value
:id	Identifiant de la candidature. Soit : - L'identifiant client : le champ eventClientId envoyé au moment de la commande trackApplication (voir la documentation du JSTag ici). - L'identifiant propre à l'API Engagement retourné par la commande trackApplication.

Body

Name	Type	Description
status	PENDING, VALIDATED, CANCELED, REFUSED ou CARRIED_OUT	Statut de la candidature ou création du compte. Défaut à PENDING
type (optionnel)	apply, account	Type d'évenement : candidature ou création de compte.

Response

200

/** Call with the body set to
* status = "VALIDATED"
*/
{
    "ok": true,
    "data": {
        "id": "activity_id",
        "clickId": "click_id",
        "missionId": "87654321-431-4321-210987654321",
        "missionClientId": "4321",
        "missionDomain": "education",
        "missionTitle": "Le titre de ma mission",
        "missionPostalCode": "33440",
        "missionDepartmentName": "Gironde",
        "missionOrganizationName": "Mon asso preferee",
        "missionOrganizationId": "xxxx",
        "toPublisherId": "mon_identifiant",
        "fromPublisherId": "identifiant_parteanire",
        "tag": "les-meilleurs-missions",
        "host": "https://xxx.yyy.fr",
        "created_at": "2024-03-13T13:00:00.000Z",
        "source": "publisher",
        "type": "account",
        "status" : "VALIDATED",
    }
}