通知先の更新

Prev Next
Patch
/api/notification_destinations/{type}/{notification_destination_id}

指定した通知先の情報を更新します。

Security
API Key: ApiKeyAuth
Header parameter nameAuthorization

認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
API KEYがabc123の場合は、Authorization: Token abc123とします。
API KEYの作成方法は、TROCCO API KEYの作成を参照ください。

Path parameters
type
stringRequired

通知先種別(email または slack_channel)

Valid values[ "email", "slack_channel" ]
Exampleemail
notification_destination_id
integer (int64) Required

通知先(email または slack_channel)のIDです。

Example1
Body parameters
Expand All
OneOf
object
object
email_config
object Required
email
string Required

更新するメールアドレス。

Exampleupdate@example.com
object
object
slack_channel_config
object Required
channel
string Required

更新するslack_channelチャンネル名。

Example#updated
webhook_url
string Required

更新するslack_channelのWebhook URL。

Examplehttps://hooks.slack_channel.com/services/XXXX/XXXX/XXXX
Responses
200

更新後の通知先情報を返します。

object
Example{ "id": 1, "type": "email", "email": "test@example.com" }
id
integer (int64)

通知先のIDです。

type
string

通知先の種類です。

Valid values[ "email", "slack_channel" ]
Exampleemail
email
string

type=email の場合に設定されるメールアドレスです。

Exampletest@example.com
channel
string | null

type=slack_channel の場合に設定されるチャンネル名です。

Example#general
400

不正なリクエストです。

401

認証エラーです。API KEYをご確認ください。

404

指定した通知先が存在しません。