GET   alerts/recipients/{recipient_id}

Gets a information about the alert recipient matching the provided recipient_id. Available targets: SMS, email and webhook.

URL Parameters

NameDescription
recipient_id

Recipient Id. Type: numeric.

Request example

curl --request GET "http://api-wpm2.apicasystem.com/v3/alerts/recipients/567?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"

Response body model example and description

{
  "recipient_id": 3456,
  "targets": [
    {
      "type": "sms",
      "id": 12,
      "name": "Email to customer",
      "to": "support@apica.io",
      "enabled": true
    },
    {
      "type": "email",
      "id": 12,
      "name": "Email to customer",
      "to": "support@apica.io",
      "enabled": true
    },
    {
      "type": "email",
      "id": 12,
      "name": "Email to customer",
      "to": "support@apica.io",
      "enabled": true
    }
  ]
}
NameType Description
recipient_id Integer

The recipient's numeric identity.

targets Array

Supported targets: SMS, email and webhook.

type String

The target's type.

id Integer

The target's numeric identity.

name String

The target's name.

to String

The target's destination.

enabled Boolean

The target is enable.