Créer/modifier des champs personnalisés par API

Folks Documentation
Folks Documentation
  • Mise à jour

Utilisez l'opération suivante pour créer (POST) ou mettre à jour (PUT) un champ personnalisé pour la compagnie ou pour un employé spécifique (voir https://api.folkshr.app/api/documentation#/Custom%20Fields).

POST /api/v2/employees/{employee}/custom-fields
PUT /api/v2/employees/{employee}/custom-fields/{custom-fields-id}

Lorsque vous créez ou modifiez un champ personnalisé, vous pouvez définir une valeur en procédant comme suit.

Pour définir une valeur pour un champ personnalisé de compagnie :

{
    "employee_id": "null"
}

Pour définir une valeur pour pour un champ personnalisé d’employé :

Lorsqu’une valeur est envoyée pour un employé, si une valeur existe déjà, la valeur existante est écrasée.

{
    "employee_id": "target_employee"
}

La valeur du champ personnalisé doit respecter le schéma du type du champ personnalisé. Lorsque la valeur “null” est envoyée, la valeur associée au champ personnalisé et à l’employé est retirée.

  • Pour un champ personnalisé de type Alpha numérique, une chaîne de caractère doit être fournie.
  • Pour un champ personnalisé de type Date, une date sous le format “YYYY-MM-DD” doit être fournie.
  • Pour un champ personnalisé de type Liste déroulante, l’identifiant d’une option doit être fourni.