Services/Suppression Rules

Get Suppression Rules

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/services/{serviceID}/suppression-rules

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/services/{serviceID}/suppression-rules

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Services.SuppressionRules.Get(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "rules": [
      {
        "rule_id": "text",
        "created_at": "2026-03-18T06:41:00.670Z",
        "updated_at": "2026-03-18T06:41:00.670Z",
        "created_by": "text",
        "updated_by": "text",
        "description": "text",
        "expression": "text",
        "is_basic": true,
        "is_timebased": true,
        "timeslots": [
          {
            "time_zone": "text",
            "start_time": "text",
            "end_time": "text",
            "is_allday": true,
            "repetition": "text",
            "is_custom": true,
            "custom": {
              "repeats_count": 1,
              "repeats": "text",
              "repeats_on_weekdays": [
                1
              ],
              "repeats_on_month": "text"
            },
            "ends_never": true,
            "ends_on": "text"
          }
        ],
        "basic_expression": [
          {
            "lhs": "text",
            "op": "text",
            "rhs": "text"
          }
        ]
      }
    ]
  }
}

Create or Update Suppression Rules

post

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/services/{serviceID}/suppression-rules

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

Body

application/json

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

post

/v3/services/{serviceID}/suppression-rules

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Services.CreateOrUpdateSuppressionRules(ctx, "<id>", components.V3ServicesSuppressionRulesCreateOrUpdateSuppressionRulesRequest{
        Rules: []components.V3ServicesSuppressionRulesSuppressionRule{},
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "created_at": "2026-03-18T06:41:00.670Z",
    "updated_at": "2026-03-18T06:41:00.670Z",
    "service_id": "text",
    "organization_id": "text",
    "rules": [
      {
        "rule_id": "text",
        "created_at": "2026-03-18T06:41:00.670Z",
        "updated_at": "2026-03-18T06:41:00.670Z",
        "created_by": "text",
        "updated_by": "text",
        "description": "text",
        "expression": "text",
        "is_basic": true,
        "is_timebased": true,
        "timeslots": [
          {
            "time_zone": "text",
            "start_time": "text",
            "end_time": "text",
            "is_allday": true,
            "repetition": "text",
            "is_custom": true,
            "custom": {
              "repeats_count": 1,
              "repeats": "text",
              "repeats_on_weekdays": [
                1
              ],
              "repeats_on_month": "text"
            },
            "ends_never": true,
            "ends_on": "text"
          }
        ],
        "basic_expression": [
          {
            "lhs": "text",
            "op": "text",
            "rhs": "text"
          }
        ]
      }
    ]
  }
}