メンバー一時停止

    連絡可能・退席中のメンバーを一時停止状態にします。

    API の種類

    サーバー API

    Request URL

    • サービス: https://apis.worksmobile.com/r/{API_ID}/organization/v2/domains/{domainId}/users/{externalKey}/pause
    • テスト: https://sandbox-apis.worksmobile.com/r/{API_ID}/organization/v2/domains/{domainId}/users/{externalKey}/pause

    HTTP Method

    POST

    Path parameters

    パラメーター タイプ 必須 説明
    domainId Integer Y ドメイン ID
    externalKey String Y 原職アカウントの ExternalKey(最大 100 字)
    ● テナント内でユニークでなければなりません
    ● 特殊文字 % \ は使えません

    Request Example

    POST https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123/pause

    Response

    API 呼び出しに成功すると HTTP 200 コードを返します。

    Error Code

    呼び出しに失敗するとエラーコードとエラーメッセージを返します。
    エラーコードは組織連携REST APIエラーコードを参照してください。