Services/Overlay/Dedup Key Overlay

Get All Dedup Key Overlay by Service

get

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

/v3/services/{serviceID}/overlays/dedup-key

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

Header parameters

authorizationstringOptional

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}/overlays/dedup-key

HTTPcURLJavaScriptPython

GET /v3/services/{serviceID}/overlays/dedup-key HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "created_at": "2026-07-10T18:36:32.803Z",
      "updated_at": "2026-07-10T18:36:32.803Z",
      "deleted_at": "2026-07-10T18:36:32.803Z",
      "org_id": "text",
      "service_id": "text",
      "alert_source_version": "text",
      "alert_source_shortname": "text",
      "overlay_template_type": "text",
      "overlay": {
        "template": "text",
        "duration": 1
      },
      "created_by": "text",
      "updated_by": "text",
      "alert_source_type": "text"
    }
  ]
}

Render Dedup Key template

post

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

/v3/services/{serviceID}/overlays/dedup-key/render

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

Body

application/json

overlay_template_typestringRequired

templatestringRequired

payloadstringRequired

Responses

200

The request has succeeded.

application/json

datastringRequired

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}/overlays/dedup-key/render

HTTPcURLJavaScriptPython

POST /v3/services/{serviceID}/overlays/dedup-key/render HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "overlay_template_type": "text",
  "template": "text",
  "payload": "text"
}

{
  "data": "text"
}

Get Dedup Key Overlay for Alert Source

get

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

/v3/services/{serviceID}/overlays/dedup-key/{alertSource}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

alertSourcestringRequired

Header parameters

authorizationstringOptional

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}/overlays/dedup-key/{alertSource}

HTTPcURLJavaScriptPython

GET /v3/services/{serviceID}/overlays/dedup-key/{alertSource} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "created_at": "2026-07-10T18:36:32.803Z",
    "updated_at": "2026-07-10T18:36:32.803Z",
    "deleted_at": "2026-07-10T18:36:32.803Z",
    "org_id": "text",
    "service_id": "text",
    "alert_source_version": "text",
    "alert_source_shortname": "text",
    "overlay_template_type": "text",
    "overlay": {
      "template": "text",
      "duration": 1
    },
    "created_by": "text",
    "updated_by": "text",
    "alert_source_type": "text"
  }
}

Update Dedup Key Overlay

put

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

/v3/services/{serviceID}/overlays/dedup-key/{alertSource}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

alertSourcestringRequired

Body

application/json

overlay_template_typestringRequired

Responses

200

The request has succeeded.

application/json

or

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

put/v3/services/{serviceID}/overlays/dedup-key/{alertSource}

HTTPcURLJavaScriptPython

PUT /v3/services/{serviceID}/overlays/dedup-key/{alertSource} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "overlay_template_type": "text",
  "dedup_key_overlay": {
    "template": "text",
    "duration": 1
  }
}

{
  "data": {
    "created_at": "2026-07-10T18:36:32.803Z",
    "updated_at": "2026-07-10T18:36:32.803Z",
    "deleted_at": "2026-07-10T18:36:32.803Z",
    "org_id": "text",
    "service_id": "text",
    "alert_source_version": "text",
    "alert_source_shortname": "text",
    "overlay_template_type": "text",
    "overlay": {
      "template": "text",
      "duration": 1
    },
    "created_by": "text",
    "updated_by": "text",
    "alert_source_type": "text"
  }
}

Delete Dedup Key Overlay

delete

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

/v3/services/{serviceID}/overlays/dedup-key/{alertSource}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceIDstringRequired

alertSourcestringRequired

Header parameters

authorizationstringOptional

Responses

204

There is no content to send for this request, but the headers may be useful.

*/*

objectOptional

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

delete/v3/services/{serviceID}/overlays/dedup-key/{alertSource}

HTTPcURLJavaScriptPython

DELETE /v3/services/{serviceID}/overlays/dedup-key/{alertSource} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}