エージェントハブでは求職者の更新APIを提供しています。APIキーを作成後に保存している求職者に対してデータを更新することが出来ます。

ベースURL

https://app.agenthub.com/api/candidate_profiles/{:id}

※ {:id} は作成時に返却されたIDを設定し、PUTメソッドで送信してください。

ヘッダー

リクエスト例

let xhr = new XMLHttpRequest();
let url = "<https://app.agenthub.com/api/candidate_profiles/:id>";
let apiKey = "APIキー";
let secretKey = "シークレットキー";

let data = JSON.stringify({
  "name": "求職者の名前",
  "email": "求職者のメールアドレス", // 例
  "skills": ["スキル1", "スキル2", "スキル3"]　// 例
  "birthDate": "2000-01-01" // 例
});

xhr.open("PUT", url, true);
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader('Authorization', 'Bearer ' + apiKey + ':' + secretKey);

xhr.onreadystatechange = function () {
  if (xhr.readyState === 4 && xhr.status === 200) {
    let json = JSON.parse(xhr.responseText);
    console.log(json);
  }
};

xhr.send(data);

送信するデータの name 以外の各パラメーター名は、管理画面から確認・編集することが可能です。同様に管理画面で必須になっているパラメーターは送信データでも入力必須になります。

成功時のレスポンス例

成功時には、以下のようなJSON形式のレスポンスが返却されます。このレスポンスには、作成された求職者プロファイルのID、名前、および送信された各パラメーターの値が含まれます。

{
  "id": "求職者プロファイルのID",
  "name": "求職者の名前",
  "email": "求職者のメールアドレス",
  "skills": ["スキル1", "スキル2", "スキル3"],
  "birthDate": "2000-01-01"
}

なお、エラーが発生した場合には、エラーメッセージとエラーコードが含まれたレスポンスが送信されます。

ファイルを添付する場合

ヘッダー