v1

latestOpenAPI 3.0.02026-07-144224981.3 MB

AlertService

Replaces the AlertService resource.

put/api/alert-service/{id}

Path parameters

idstring required

AlertService identifier

Request body

alertServiceNamestring nullable required

The name of the alert service. Max 255 characters.

alertServiceNotesstring nullable

Notes about the alert service. Max 10,000 characters. Formatting using Markdown is allowed. HTML will be removed.

dataSegmentCodestring nullable

User-provided string on which to segment and filter data. Max 50 characters.

mediaObjectsstring[]

Media objects that must be sent with each alert. Only applicable when you use your own email alert services.

recipientEmailAddressstring email nullable required

The email address where alerts will be sent.

recipientPhoneNumberstring nullable required

The phone number where alerts will be sent. Ensure that the number format complies with the external transport service that will send the alert.

transportAlertastring iri-reference nullable

transportAllMySmsstring iri-reference nullable

transportAmazonSnsstring iri-reference nullable

transportBandwidthstring iri-reference nullable

transportChatworkstring iri-reference nullable

transportClickSendstring iri-reference nullable

transportClickatellstring iri-reference nullable

transportContactEveryonestring iri-reference nullable

transportDiscordstring iri-reference nullable

transportEmailstring iri-reference nullable

transportEngagespotstring iri-reference nullable

transportEsendexstring iri-reference nullable

transportExpostring iri-reference nullable

transportFirebasestring iri-reference nullable

transportFortySixElksstring iri-reference nullable

transportFreeMobilestring iri-reference nullable

transportFreshdeskstring iri-reference nullable

transportGatewayApistring iri-reference nullable

transportGitterstring iri-reference nullable

transportGoogleChatstring iri-reference nullable

transportGotifystring iri-reference nullable

transportHelpScoutstring iri-reference nullable

transportInfobipstring iri-reference nullable

transportIqsmsstring iri-reference nullable

transportKazInfoTehstring iri-reference nullable

transportLightSmsstring iri-reference nullable

transportLineNotifystring iri-reference nullable

transportLinkedInstring iri-reference nullable

transportMailjetstring iri-reference nullable

transportMastodonstring iri-reference nullable

transportMattermoststring iri-reference nullable

transportMercurestring iri-reference nullable

transportMessageBirdstring iri-reference nullable

transportMessageMediastring iri-reference nullable

transportMicrosoftTeamsstring iri-reference nullable

transportMobytstring iri-reference nullable

transportOctopushstring iri-reference nullable

transportOneSignalstring iri-reference nullable

transportOpsgeniestring iri-reference nullable

transportOrangeSmsstring iri-reference nullable

transportOvhCloudstring iri-reference nullable

transportPagerDutystring iri-reference nullable

transportPagerTreestring iri-reference nullable

transportPlivostring iri-reference nullable

transportPushbulletstring iri-reference nullable

transportPushoverstring iri-reference nullable

transportPushystring iri-reference nullable

transportRingCentralstring iri-reference nullable

transportRocketChatstring iri-reference nullable

transportSendberrystring iri-reference nullable

transportSendinbluestring iri-reference nullable

transportSimpleTextinstring iri-reference nullable

transportSinchstring iri-reference nullable

transportSlackstring iri-reference nullable

transportSms77string iri-reference nullable

transportSmsBiurasstring iri-reference nullable

transportSmsFactorstring iri-reference nullable

transportSmsapistring iri-reference nullable

transportSmscstring iri-reference nullable

transportSmsmodestring iri-reference nullable

transportSpotHitstring iri-reference nullable

transportTelegramstring iri-reference nullable

transportTelnyxstring iri-reference nullable

transportTermiistring iri-reference nullable

transportTrellostring iri-reference nullable

transportTurboSmsstring iri-reference nullable

transportTwiliostring iri-reference nullable

transportTwitterstring iri-reference nullable

transportVonagestring iri-reference nullable

transportWebhookstring iri-reference nullable

transportYunpianstring iri-reference nullable

transportZendeskstring iri-reference nullable

transportZulipstring iri-reference nullable

Response

AlertService resource updated

alertServiceNamestring nullable required

The name of the alert service. Max 255 characters.

alertServiceNotesstring nullable

Notes about the alert service. Max 10,000 characters. Formatting using Markdown is allowed. HTML will be removed.

alertServiceTransportCodestring iri-reference nullable required

The transport of the alert service.

createdAtstring date-time

When the resource instance was created. This date-time is in the UTC timezone.

creditsPerTransportAlertinteger

The phone number where alerts will be sent. Ensure that the number format complies with the external transport service that will send the alert.

dataSegmentCodestring nullable

User-provided string on which to segment and filter data. Max 50 characters.

idstring uuid nullable

The unique identifier of the resource instance.

mediaObjectsstring[]

Media objects that must be sent with each alert. Only applicable when you use your own email alert services.

partitionstring iri-reference required

The partition that contains this resource instance. The resource cannot be moved to another partition.

recipientEmailAddressstring email nullable required

The email address where alerts will be sent.

recipientPhoneNumberstring nullable required

The phone number where alerts will be sent. Ensure that the number format complies with the external transport service that will send the alert.

resourceOwnerstring nullable

The name of the person who owns this resource.

transportAlertastring iri-reference nullable

transportAllMySmsstring iri-reference nullable

transportAmazonSnsstring iri-reference nullable

transportBandwidthstring iri-reference nullable

transportChatworkstring iri-reference nullable

transportClickSendstring iri-reference nullable

transportClickatellstring iri-reference nullable

transportContactEveryonestring iri-reference nullable

transportDiscordstring iri-reference nullable

transportEmailstring iri-reference nullable

transportEngagespotstring iri-reference nullable

transportEsendexstring iri-reference nullable

transportExpostring iri-reference nullable

transportFirebasestring iri-reference nullable

transportFortySixElksstring iri-reference nullable

transportFreeMobilestring iri-reference nullable

transportFreshdeskstring iri-reference nullable

transportGatewayApistring iri-reference nullable

transportGitterstring iri-reference nullable

transportGoogleChatstring iri-reference nullable

transportGotifystring iri-reference nullable

transportHelpScoutstring iri-reference nullable

transportInfobipstring iri-reference nullable

transportIqsmsstring iri-reference nullable

transportKazInfoTehstring iri-reference nullable

transportLightSmsstring iri-reference nullable

transportLineNotifystring iri-reference nullable

transportLinkedInstring iri-reference nullable

transportMailjetstring iri-reference nullable

transportMastodonstring iri-reference nullable

transportMattermoststring iri-reference nullable

transportMercurestring iri-reference nullable

transportMessageBirdstring iri-reference nullable

transportMessageMediastring iri-reference nullable

transportMicrosoftTeamsstring iri-reference nullable

transportMobytstring iri-reference nullable

transportOctopushstring iri-reference nullable

transportOneSignalstring iri-reference nullable

transportOpsgeniestring iri-reference nullable

transportOrangeSmsstring iri-reference nullable

transportOvhCloudstring iri-reference nullable

transportPagerDutystring iri-reference nullable

transportPagerTreestring iri-reference nullable

transportPlivostring iri-reference nullable

transportPushbulletstring iri-reference nullable

transportPushoverstring iri-reference nullable

transportPushystring iri-reference nullable

transportRingCentralstring iri-reference nullable

transportRocketChatstring iri-reference nullable

transportSendberrystring iri-reference nullable

transportSendinbluestring iri-reference nullable

transportSimpleTextinstring iri-reference nullable

transportSinchstring iri-reference nullable

transportSlackstring iri-reference nullable

transportSms77string iri-reference nullable

transportSmsBiurasstring iri-reference nullable

transportSmsFactorstring iri-reference nullable

transportSmsapistring iri-reference nullable

transportSmscstring iri-reference nullable

transportSmsmodestring iri-reference nullable

transportSpotHitstring iri-reference nullable

transportTelegramstring iri-reference nullable

transportTelnyxstring iri-reference nullable

transportTermiistring iri-reference nullable

transportTrellostring iri-reference nullable

transportTurboSmsstring iri-reference nullable

transportTwiliostring iri-reference nullable

transportTwitterstring iri-reference nullable

transportVonagestring iri-reference nullable

transportWebhookstring iri-reference nullable

transportYunpianstring iri-reference nullable

transportZendeskstring iri-reference nullable

transportZulipstring iri-reference nullable

Example response

{
  "creditsPerTransportAlert": 1
}