Examples

POST /api/v2/activity-alerts
{
  "data": {
    "type": "activity-alerts",
    "attributes": {
      "name": "Company Alert",
      "email-delivery": true,
      "notification-delivery": true,
      "enabled": true
    },
    "relationships": {
      "account": {
        "data": {
          "type": "accounts",
          "id": "6"
        }
      }
    }
  }
}
201
{
  "data": {
    "id": "6",
    "type": "activity-alerts",
    "links": {
      "self": "http://test.host/api/v2/activity-alerts/6"
    },
    "attributes": {
      "name": "Company Alert",
      "email-delivery": true,
      "notification-delivery": true,
      "enabled": true
    },
    "relationships": {
      "account": {
        "links": {
          "self": "http://test.host/api/v2/activity-alerts/6/relationships/account",
          "related": "http://test.host/api/v2/activity-alerts/6/account"
        }
      },
      "company": {
        "links": {
          "self": "http://test.host/api/v2/activity-alerts/6/relationships/company",
          "related": "http://test.host/api/v2/activity-alerts/6/company"
        }
      }
    }
  }
}

Params

Param name Description
data
required

alert information

Validations:

  • Must be a Hash

data[type]
required

Validations: