メインコンテンツへスキップ
PATCH
取引の事前設定を変更

承認

Authorization
string
header
必須

Stockwork が発行する API キー(sk_ プレフィックス、base62 ランダム ≥ 40 文字)。 キーには 1 つの role(read / analyst / write / admin)が紐付き、 各エンドポイントの必要 role 以上であることが要求される(対応表は info.description 参照)。

パスパラメータ

record_id
string
必須

Stockwork record_id(18 文字英数字)

Pattern: ^[A-Za-z0-9]{18}$

ボディ

application/json

取引の事前設定の入力。送ったキーだけを更新する。null(配列は [])を送ると解除する。 genre は properties/ の options[].value と完全一致で指定する(ラベルの曖昧一致はしない)。 deal_id と genre はセットで設定する。送った値を現在の設定に重ねた結果、どちらか一方だけになる場合は 400 になる(取引の自動紐付けは、取引とジャンルがそろったときだけ商談ログを作るため)。 assignee_ids は GET /v1/users/ の record_id で指定する。指定できるのは組織の有効なメンバーだけで、 読み取りで返る assignee_ids には退会したメンバーも含まれる。読んだ値をそのまま送ると、 退会者が含まれる場合は 400 になる。

deal_id
string | null

取引の record_id

genre
string | null

商談ジャンル

assignee_ids
string[]

担当者(User)の record_id の配列

participants
string | null

参加者(自由記述)

レスポンス

更新成功

連携カレンダーの予定 1 件。予定は持ち主ごとに別レコードになるため、同じ会議に Stockwork ユーザーが複数参加していると、同じ会議が複数の予定として現れる。 同じ会議かどうかは meeting_key で判別する。

API キーに返るのは会議 URL があり、非公開でない予定だけ。予定が後から非公開に 変更された場合は、一覧から消え、単体取得も 404 になる(差分同期では検知できないため、 保持している予定を取得して 404 なら対象外になったと扱う)。

id
string
必須

Stockwork record_id(18 文字)

例:

"Ce7XkQpYz3Lh9vMs2N"

title
string
必須

予定の件名

start_time
string<date-time>
必須
end_time
string<date-time>
必須
status
enum<string>
必須

cancelled はカレンダー側でキャンセル(削除)された予定

利用可能なオプション:
active,
cancelled
meeting_url
string | null
必須

Web 会議の参加 URL。無い予定は録画を予約できない

meeting_platform
enum<string> | null
必須
利用可能なオプション:
zoom,
google_meet,
microsoft_teams,
other,
null
meeting_key
string | null
必須

同じ会議を束ねる不透明なキー。会議 URL と開始時刻から計算され、どちらかが 変わると値も変わる。meeting_url が無い予定は null

owner_id
string
必須

予定の持ち主(カレンダーを連携しているユーザー)の record_id。 録画を予約すると、この人が録音の所有者(閲覧権限・文字起こし利用枠の計上先)になる

organizer_email
string | null
必須

会議の主催者のメールアドレス

ical_uid
string | null
必須

カレンダー側の予定識別子(iCalUId)。繰り返し予定では各回で共通

is_recurring
boolean
必須

繰り返し予定の 1 回か

recording
object
必須

予定に対する録画の状態

deal_linking
object
必須

録音後に紐付ける取引の事前設定。画面の「取引自動紐づけ」と同じ。 文字起こし完了後、deal_id の取引へ自動で確定紐付けされ、商談ログが作成される。

例:
created_at
string<date-time>
必須
updated_at
string<date-time>
必須

予定の内容・録画の予約/取り消し・取引の事前設定のいずれかが変わった日時。 内容が同じままの再同期では進まない。録画の進行(入室・終了)は予約先の商談音声 (recording.meeting_record_id)の updated_at で追う