取引を部分更新
curl --request PATCH \
--url https://api.strixai.jp/v1/deals/{record_id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"properties": {
"stage": "won",
"amount": 5500000,
"close_date": null
}
}
'import requests
url = "https://api.strixai.jp/v1/deals/{record_id}/"
payload = { "properties": {
"stage": "won",
"amount": 5500000,
"close_date": None
} }
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({properties: {stage: 'won', amount: 5500000, close_date: null}})
};
fetch('https://api.strixai.jp/v1/deals/{record_id}/', 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.strixai.jp/v1/deals/{record_id}/",
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([
'properties' => [
'stage' => 'won',
'amount' => 5500000,
'close_date' => null
]
]),
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.strixai.jp/v1/deals/{record_id}/"
payload := strings.NewReader("{\n \"properties\": {\n \"stage\": \"won\",\n \"amount\": 5500000,\n \"close_date\": null\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.strixai.jp/v1/deals/{record_id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"properties\": {\n \"stage\": \"won\",\n \"amount\": 5500000,\n \"close_date\": null\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.strixai.jp/v1/deals/{record_id}/")
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 \"properties\": {\n \"stage\": \"won\",\n \"amount\": 5500000,\n \"close_date\": null\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "Rb7XkQpYz3Lh9vMs2N",
"properties": {
"name": "株式会社サンプル 新規導入",
"amount": 5000000,
"close_date": "2026-09-30",
"stage": "proposal",
"account_id": "Ac7XkQpYz3Lh9vMs2N",
"owner_id": "Us7XkQpYz3Lh9vMs2N"
},
"created_at": "2026-06-01T09:00:00Z",
"updated_at": "2026-06-12T05:40:00Z"
}{
"error": {
"code": "validation_error",
"message": "リクエストの検証に失敗しました。",
"fields": [
{
"name": "properties.name",
"code": "required",
"message": "この項目は必須です。"
}
]
}
}{
"error": {
"code": "validation_error",
"message": "リクエストの検証に失敗しました。",
"fields": [
{
"name": "properties.name",
"code": "required",
"message": "この項目は必須です。"
}
]
}
}{
"error": {
"code": "validation_error",
"message": "リクエストの検証に失敗しました。",
"fields": [
{
"name": "properties.name",
"code": "required",
"message": "この項目は必須です。"
}
]
}
}{
"error": {
"code": "validation_error",
"message": "リクエストの検証に失敗しました。",
"fields": [
{
"name": "properties.name",
"code": "required",
"message": "この項目は必須です。"
}
]
}
}{
"error": {
"code": "validation_error",
"message": "リクエストの検証に失敗しました。",
"fields": [
{
"name": "properties.name",
"code": "required",
"message": "この項目は必須です。"
}
]
}
}Deals
取引を部分更新
送信したプロパティのみ更新される(他フィールドは保持)。
PATCH
/
v1
/
deals
/
{record_id}
/
取引を部分更新
curl --request PATCH \
--url https://api.strixai.jp/v1/deals/{record_id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"properties": {
"stage": "won",
"amount": 5500000,
"close_date": null
}
}
'import requests
url = "https://api.strixai.jp/v1/deals/{record_id}/"
payload = { "properties": {
"stage": "won",
"amount": 5500000,
"close_date": None
} }
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({properties: {stage: 'won', amount: 5500000, close_date: null}})
};
fetch('https://api.strixai.jp/v1/deals/{record_id}/', 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.strixai.jp/v1/deals/{record_id}/",
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([
'properties' => [
'stage' => 'won',
'amount' => 5500000,
'close_date' => null
]
]),
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.strixai.jp/v1/deals/{record_id}/"
payload := strings.NewReader("{\n \"properties\": {\n \"stage\": \"won\",\n \"amount\": 5500000,\n \"close_date\": null\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.strixai.jp/v1/deals/{record_id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"properties\": {\n \"stage\": \"won\",\n \"amount\": 5500000,\n \"close_date\": null\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.strixai.jp/v1/deals/{record_id}/")
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 \"properties\": {\n \"stage\": \"won\",\n \"amount\": 5500000,\n \"close_date\": null\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "Rb7XkQpYz3Lh9vMs2N",
"properties": {
"name": "株式会社サンプル 新規導入",
"amount": 5000000,
"close_date": "2026-09-30",
"stage": "proposal",
"account_id": "Ac7XkQpYz3Lh9vMs2N",
"owner_id": "Us7XkQpYz3Lh9vMs2N"
},
"created_at": "2026-06-01T09:00:00Z",
"updated_at": "2026-06-12T05:40:00Z"
}{
"error": {
"code": "validation_error",
"message": "リクエストの検証に失敗しました。",
"fields": [
{
"name": "properties.name",
"code": "required",
"message": "この項目は必須です。"
}
]
}
}{
"error": {
"code": "validation_error",
"message": "リクエストの検証に失敗しました。",
"fields": [
{
"name": "properties.name",
"code": "required",
"message": "この項目は必須です。"
}
]
}
}{
"error": {
"code": "validation_error",
"message": "リクエストの検証に失敗しました。",
"fields": [
{
"name": "properties.name",
"code": "required",
"message": "この項目は必須です。"
}
]
}
}{
"error": {
"code": "validation_error",
"message": "リクエストの検証に失敗しました。",
"fields": [
{
"name": "properties.name",
"code": "required",
"message": "この項目は必須です。"
}
]
}
}{
"error": {
"code": "validation_error",
"message": "リクエストの検証に失敗しました。",
"fields": [
{
"name": "properties.name",
"code": "required",
"message": "この項目は必須です。"
}
]
}
}承認
Stockwork が発行する API キー(sk_ プレフィックス、base62 ランダム ≥ 40 文字)。
キーには 1 つの role(read / analyst / write / admin)が紐付き、
各エンドポイントの必要 role 以上であることが要求される(対応表は info.description 参照)。
パスパラメータ
Stockwork record_id(18 文字英数字)
Pattern:
^[A-Za-z0-9]{18}$ボディ
application/json
部分更新可。送信したプロパティのみが更新される。
値をクリアしたい場合は明示的に null を送る(下の例の close_date)。
Show child attributes
Show child attributes
レスポンス
更新成功
取引(Deal)レコード
Stockwork record_id(18 文字)。クライアントはこの ID を保存して以降の参照に使う。
例:
"Rb7XkQpYz3Lh9vMs2N"
取引のプロパティ集合。name は必須。
amount/close_date/stage 等のコアフィールドと、組織別カスタムプロパティが
同じ namespace で扱われる。
リレーションは record_id 文字列で表す。
account_id— 商談先の会社(Account)owner_id— 担当ユーザー(User)。GET /v1/users/で解決する
Show child attributes
Show child attributes
レコードの値が最後に変わった日時。コアフィールド・カスタムプロパティ・アクティビティ件数などの集計値のいずれかが実際に変わったときに進む。商談ログやメールなどの活動を記録した場合も、それが集計値を動かすためこの日時が進む。同じ値での再保存や、他レコードとの紐付け変更では進まない。