Examples

PATCH /api/v2/activity-alerts/2
{
  "data": {
    "id": "2",
    "type": "activity-alerts",
    "attributes": {
      "name": "Company Alert",
      "email-delivery": true,
      "notification-delivery": true,
      "enabled": false
    },
    "relationships": {
      "account": {
        "data": {
          "type": "accounts",
          "id": "2"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "4"
        }
      }
    }
  }
}
200
{
  "data": {
    "id": "2",
    "type": "activity-alerts",
    "links": {
      "self": "http://test.host/api/v2/activity-alerts/2"
    },
    "attributes": {
      "name": "Company Alert",
      "email-delivery": true,
      "notification-delivery": true,
      "enabled": false
    },
    "relationships": {
      "account": {
        "links": {
          "self": "http://test.host/api/v2/activity-alerts/2/relationships/account",
          "related": "http://test.host/api/v2/activity-alerts/2/account"
        }
      },
      "company": {
        "links": {
          "self": "http://test.host/api/v2/activity-alerts/2/relationships/company",
          "related": "http://test.host/api/v2/activity-alerts/2/company"
        }
      }
    }
  }
}

Params

Param name Description
id
required

alert ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

alert information

Validations:

  • Must be a Hash

data[type]
optional

Validations: