メインコンテンツへスキップ
POST
コンタクトを作成

承認

Authorization
string
header
必須

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

ボディ

application/json
properties
object
必須

last_name または email のいずれか必須。 会社に紐付けたい場合は account_id に Account の record_id を指定。

shared_user_ids
string[]

作成と同時にレコードを共有する組織のメンバー(ユーザーの record_id)。properties.visibility を private にすると、作成者とここに挙げたメンバーだけが閲覧できます。公開範囲は作成時にだけ指定でき、組織の API キーでは限定公開のレコードを作れません。

レスポンス

作成成功

コンタクトレコード

id
string
必須

Stockwork record_id(18 文字)

例:

"Co7XkQpYz3Lh9vMs2N"

properties
object
必須

コンタクトのプロパティ集合。last_name または email のいずれか必須。 会社へ紐付けたい場合は properties.account_id に Account の record_id を入れる。

読み取り専用: display_name / account_name / account_restricted / owner_name / created_by_name / deal_ids / activity_count / last_activity_at、および SFA 由来の <source_type>_<api_name>。 作成・更新で指定すると 400。閲覧できない会社の名前は null、deal_ids は閲覧できる取引のみ。

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

レコードの値が最後に変わった日時。コアフィールド・カスタムプロパティ・アクティビティ件数などの集計値のいずれかが実際に変わったときに進む。商談ログやメールなどの活動を記録した場合も、それが集計値を動かすためこの日時が進む。同じ値での再保存や、他レコードとの紐付け変更では進まない。