メインコンテンツへスキップ
PATCH
/
api
/
v1
/
organizations
/
{organizationId}
/
workspaces
/
{workspaceId}
/
files
/
safe-lists
/
{safeListId}
Update a safe list for a workspace
curl --request PATCH \
  --url https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/files/safe-lists/{safeListId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "foo bar baz",
  "remarks": "foo bar baz description",
  "allFiles": true,
  "highConfidence": true,
  "create": {
    "safeDomains": [
      "foo.com",
      "bar.com"
    ],
    "safeEmailIds": [
      "foo@example.com"
    ],
    "safeFiles": [
      {
        "name": "foo",
        "id": "asdfgh12345"
      }
    ],
    "safeGroups": [
      {
        "name": "foo",
        "id": "asdfgh12345"
      }
    ]
  },
  "delete": {
    "safeDomains": [
      "foo.com",
      "bar.com"
    ],
    "safeEmailIds": [
      "foo@example.com"
    ],
    "safeFiles": [
      {
        "name": "foo",
        "id": "asdfgh12345"
      }
    ],
    "safeGroups": [
      {
        "name": "foo",
        "id": "asdfgh12345"
      }
    ]
  }
}
'
import requests

url = "https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/files/safe-lists/{safeListId}"

payload = {
    "name": "foo bar baz",
    "remarks": "foo bar baz description",
    "allFiles": True,
    "highConfidence": True,
    "create": {
        "safeDomains": ["foo.com", "bar.com"],
        "safeEmailIds": ["foo@example.com"],
        "safeFiles": [
            {
                "name": "foo",
                "id": "asdfgh12345"
            }
        ],
        "safeGroups": [
            {
                "name": "foo",
                "id": "asdfgh12345"
            }
        ]
    },
    "delete": {
        "safeDomains": ["foo.com", "bar.com"],
        "safeEmailIds": ["foo@example.com"],
        "safeFiles": [
            {
                "name": "foo",
                "id": "asdfgh12345"
            }
        ],
        "safeGroups": [
            {
                "name": "foo",
                "id": "asdfgh12345"
            }
        ]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'foo bar baz',
    remarks: 'foo bar baz description',
    allFiles: true,
    highConfidence: true,
    create: {
      safeDomains: ['foo.com', 'bar.com'],
      safeEmailIds: ['foo@example.com'],
      safeFiles: [{name: 'foo', id: 'asdfgh12345'}],
      safeGroups: [{name: 'foo', id: 'asdfgh12345'}]
    },
    delete: {
      safeDomains: ['foo.com', 'bar.com'],
      safeEmailIds: ['foo@example.com'],
      safeFiles: [{name: 'foo', id: 'asdfgh12345'}],
      safeGroups: [{name: 'foo', id: 'asdfgh12345'}]
    }
  })
};

fetch('https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/files/safe-lists/{safeListId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/files/safe-lists/{safeListId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'foo bar baz',
    'remarks' => 'foo bar baz description',
    'allFiles' => true,
    'highConfidence' => true,
    'create' => [
        'safeDomains' => [
                'foo.com',
                'bar.com'
        ],
        'safeEmailIds' => [
                'foo@example.com'
        ],
        'safeFiles' => [
                [
                                'name' => 'foo',
                                'id' => 'asdfgh12345'
                ]
        ],
        'safeGroups' => [
                [
                                'name' => 'foo',
                                'id' => 'asdfgh12345'
                ]
        ]
    ],
    'delete' => [
        'safeDomains' => [
                'foo.com',
                'bar.com'
        ],
        'safeEmailIds' => [
                'foo@example.com'
        ],
        'safeFiles' => [
                [
                                'name' => 'foo',
                                'id' => 'asdfgh12345'
                ]
        ],
        'safeGroups' => [
                [
                                'name' => 'foo',
                                'id' => 'asdfgh12345'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/files/safe-lists/{safeListId}"

	payload := strings.NewReader("{\n  \"name\": \"foo bar baz\",\n  \"remarks\": \"foo bar baz description\",\n  \"allFiles\": true,\n  \"highConfidence\": true,\n  \"create\": {\n    \"safeDomains\": [\n      \"foo.com\",\n      \"bar.com\"\n    ],\n    \"safeEmailIds\": [\n      \"foo@example.com\"\n    ],\n    \"safeFiles\": [\n      {\n        \"name\": \"foo\",\n        \"id\": \"asdfgh12345\"\n      }\n    ],\n    \"safeGroups\": [\n      {\n        \"name\": \"foo\",\n        \"id\": \"asdfgh12345\"\n      }\n    ]\n  },\n  \"delete\": {\n    \"safeDomains\": [\n      \"foo.com\",\n      \"bar.com\"\n    ],\n    \"safeEmailIds\": [\n      \"foo@example.com\"\n    ],\n    \"safeFiles\": [\n      {\n        \"name\": \"foo\",\n        \"id\": \"asdfgh12345\"\n      }\n    ],\n    \"safeGroups\": [\n      {\n        \"name\": \"foo\",\n        \"id\": \"asdfgh12345\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/files/safe-lists/{safeListId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"foo bar baz\",\n  \"remarks\": \"foo bar baz description\",\n  \"allFiles\": true,\n  \"highConfidence\": true,\n  \"create\": {\n    \"safeDomains\": [\n      \"foo.com\",\n      \"bar.com\"\n    ],\n    \"safeEmailIds\": [\n      \"foo@example.com\"\n    ],\n    \"safeFiles\": [\n      {\n        \"name\": \"foo\",\n        \"id\": \"asdfgh12345\"\n      }\n    ],\n    \"safeGroups\": [\n      {\n        \"name\": \"foo\",\n        \"id\": \"asdfgh12345\"\n      }\n    ]\n  },\n  \"delete\": {\n    \"safeDomains\": [\n      \"foo.com\",\n      \"bar.com\"\n    ],\n    \"safeEmailIds\": [\n      \"foo@example.com\"\n    ],\n    \"safeFiles\": [\n      {\n        \"name\": \"foo\",\n        \"id\": \"asdfgh12345\"\n      }\n    ],\n    \"safeGroups\": [\n      {\n        \"name\": \"foo\",\n        \"id\": \"asdfgh12345\"\n      }\n    ]\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/files/safe-lists/{safeListId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"foo bar baz\",\n  \"remarks\": \"foo bar baz description\",\n  \"allFiles\": true,\n  \"highConfidence\": true,\n  \"create\": {\n    \"safeDomains\": [\n      \"foo.com\",\n      \"bar.com\"\n    ],\n    \"safeEmailIds\": [\n      \"foo@example.com\"\n    ],\n    \"safeFiles\": [\n      {\n        \"name\": \"foo\",\n        \"id\": \"asdfgh12345\"\n      }\n    ],\n    \"safeGroups\": [\n      {\n        \"name\": \"foo\",\n        \"id\": \"asdfgh12345\"\n      }\n    ]\n  },\n  \"delete\": {\n    \"safeDomains\": [\n      \"foo.com\",\n      \"bar.com\"\n    ],\n    \"safeEmailIds\": [\n      \"foo@example.com\"\n    ],\n    \"safeFiles\": [\n      {\n        \"name\": \"foo\",\n        \"id\": \"asdfgh12345\"\n      }\n    ],\n    \"safeGroups\": [\n      {\n        \"name\": \"foo\",\n        \"id\": \"asdfgh12345\"\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body
{}

承認

​
Authorization
string
header
必須

For authenticated requests, set the Authorization: Bearer your_api_key parameter in the header.
You can create and manage your API Keys by visiting the API Keys tab in the Settings page of your organization in Admina

パスパラメータ

​
organizationId
number
必須
​
workspaceId
number
必須
​
safeListId
string
必須

ボディ

application/json
​
name
string
例:

"foo bar baz"

​
remarks
string
例:

"foo bar baz description"

​
allFiles
boolean
例:

true

​
highConfidence
boolean
例:

true

​
create
object
​
delete
object

レスポンス

200 - application/json

The response is of type object.

最終更新日 2026年7月10日