JavaScript
import Courier from '@trycourier/courier';
const client = new Courier({
apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});
const check = await client.notifications.checks.update('submissionId', {
id: 'id',
checks: [
{
id: 'id',
status: 'RESOLVED',
type: 'custom',
},
],
});
console.log(check.checks);import os
from courier import Courier
client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
check = client.notifications.checks.update(
submission_id="submissionId",
id="id",
checks=[{
"id": "id",
"status": "RESOLVED",
"type": "custom",
}],
)
print(check.checks)package main
import (
"context"
"fmt"
"github.com/trycourier/courier-go"
"github.com/trycourier/courier-go/option"
)
func main() {
client := courier.NewClient(
option.WithAPIKey("My API Key"),
)
check, err := client.Notifications.Checks.Update(
context.TODO(),
"submissionId",
courier.NotificationCheckUpdateParams{
ID: "id",
Checks: []courier.BaseCheckParam{{
ID: "id",
Status: courier.BaseCheckStatusResolved,
Type: courier.BaseCheckTypeCustom,
}},
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", check.Checks)
}
package com.courier.example;
import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.notifications.BaseCheck;
import com.courier.models.notifications.checks.CheckUpdateParams;
import com.courier.models.notifications.checks.CheckUpdateResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
CourierClient client = CourierOkHttpClient.fromEnv();
CheckUpdateParams params = CheckUpdateParams.builder()
.id("id")
.submissionId("submissionId")
.addCheck(BaseCheck.builder()
.id("id")
.status(BaseCheck.Status.RESOLVED)
.type(BaseCheck.Type.CUSTOM)
.build())
.build();
CheckUpdateResponse check = client.notifications().checks().update(params);
}
}require "courier"
courier = Courier::Client.new(api_key: "My API Key")
check = courier.notifications.checks.update(
"submissionId",
id: "id",
checks: [{id: "id", status: :RESOLVED, type: :custom}]
)
puts(check)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Courier\Client;
use Courier\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API Key');
try {
$check = $client->notifications->checks->update(
'submissionId',
id: 'id',
checks: [['id' => 'id', 'status' => 'RESOLVED', 'type' => 'custom']],
);
var_dump($check);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using TryCourier;
using Notifications = TryCourier.Models.Notifications;
using TryCourier.Models.Notifications.Checks;
CourierClient client = new();
CheckUpdateParams parameters = new()
{
ID = "id",
SubmissionID = "submissionId",
Checks =
[
new()
{
ID = "id",
Status = Notifications::Status.Resolved,
Type = Notifications::Type.Custom,
},
],
};
var check = await client.Notifications.Checks.Update(parameters);
Console.WriteLine(check);courier notifications:checks update \
--api-key 'My API Key' \
--id id \
--submission-id submissionId \
--check '{id: id, status: RESOLVED, type: custom}'curl --request PUT \
--url https://api.courier.com/notifications/{id}/{submissionId}/checks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"checks": [
{
"id": "<string>",
"type": "custom"
}
]
}
'{
"checks": [
{
"id": "abc-123",
"status": "RESOLVED",
"type": "custom",
"updated": 1
}
]
}Notification Templates
Replace Submission Checks
Replace the submission checks for a notification template.
PUT
/
notifications
/
{id}
/
{submissionId}
/
checks
JavaScript
import Courier from '@trycourier/courier';
const client = new Courier({
apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});
const check = await client.notifications.checks.update('submissionId', {
id: 'id',
checks: [
{
id: 'id',
status: 'RESOLVED',
type: 'custom',
},
],
});
console.log(check.checks);import os
from courier import Courier
client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
check = client.notifications.checks.update(
submission_id="submissionId",
id="id",
checks=[{
"id": "id",
"status": "RESOLVED",
"type": "custom",
}],
)
print(check.checks)package main
import (
"context"
"fmt"
"github.com/trycourier/courier-go"
"github.com/trycourier/courier-go/option"
)
func main() {
client := courier.NewClient(
option.WithAPIKey("My API Key"),
)
check, err := client.Notifications.Checks.Update(
context.TODO(),
"submissionId",
courier.NotificationCheckUpdateParams{
ID: "id",
Checks: []courier.BaseCheckParam{{
ID: "id",
Status: courier.BaseCheckStatusResolved,
Type: courier.BaseCheckTypeCustom,
}},
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", check.Checks)
}
package com.courier.example;
import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.notifications.BaseCheck;
import com.courier.models.notifications.checks.CheckUpdateParams;
import com.courier.models.notifications.checks.CheckUpdateResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
CourierClient client = CourierOkHttpClient.fromEnv();
CheckUpdateParams params = CheckUpdateParams.builder()
.id("id")
.submissionId("submissionId")
.addCheck(BaseCheck.builder()
.id("id")
.status(BaseCheck.Status.RESOLVED)
.type(BaseCheck.Type.CUSTOM)
.build())
.build();
CheckUpdateResponse check = client.notifications().checks().update(params);
}
}require "courier"
courier = Courier::Client.new(api_key: "My API Key")
check = courier.notifications.checks.update(
"submissionId",
id: "id",
checks: [{id: "id", status: :RESOLVED, type: :custom}]
)
puts(check)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Courier\Client;
use Courier\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API Key');
try {
$check = $client->notifications->checks->update(
'submissionId',
id: 'id',
checks: [['id' => 'id', 'status' => 'RESOLVED', 'type' => 'custom']],
);
var_dump($check);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using TryCourier;
using Notifications = TryCourier.Models.Notifications;
using TryCourier.Models.Notifications.Checks;
CourierClient client = new();
CheckUpdateParams parameters = new()
{
ID = "id",
SubmissionID = "submissionId",
Checks =
[
new()
{
ID = "id",
Status = Notifications::Status.Resolved,
Type = Notifications::Type.Custom,
},
],
};
var check = await client.Notifications.Checks.Update(parameters);
Console.WriteLine(check);courier notifications:checks update \
--api-key 'My API Key' \
--id id \
--submission-id submissionId \
--check '{id: id, status: RESOLVED, type: custom}'curl --request PUT \
--url https://api.courier.com/notifications/{id}/{submissionId}/checks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"checks": [
{
"id": "<string>",
"type": "custom"
}
]
}
'{
"checks": [
{
"id": "abc-123",
"status": "RESOLVED",
"type": "custom",
"updated": 1
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
Submission checks replaced.
Show child attributes
Show child attributes
⌘I