v1

latestSwagger 2.02026-08-043765135.6 KB
notifications

Create Action

Create a new action.

post/notifications/actions

Query parameters

mockboolean

Return mock data

Request body

Example request

{
  "data": {
    "attributes": {
      "organizationId": "00000000-0000-0000-0000-000000000067",
      "target": [
        "appointmentCustomer",
        "appointmentAssociate"
      ],
      "eventType": [
        "appointmentRequested",
        "appointmentNoShow"
      ],
      "resourceFilter": [
        "/organizations/f759af6a-2d8d-42b4-8a63-a17582404a9d/services/759af6a-2d8d-42b4-8a63-a17582404a9d"
      ],
      "customTarget": [
        "associate@example.com",
        "customer@example.com"
      ],
      "templateId": "00000000-0000-0000-0000-000000000067"
    }
  }
}

Response

Return a single data response

Example response

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000067",
    "attributes": {
      "target": [
        "appointmentCustomer",
        "appointmentAssociate"
      ],
      "resourceFilter": [
        "/organizations/f759af6a-2d8d-42b4-8a63-a17582404a9d/services/759af6a-2d8d-42b4-8a63-a17582404a9d"
      ],
      "customTarget": [
        "associate@example.com",
        "customer@example.com"
      ],
      "createdAt": "2018-02-03T10:30:00Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "bdb88373-bf66-4bfc-a4f8-3a35be5c2f9c"
        }
      },
      "template": {
        "data": {
          "type": "templates",
          "id": "bdb88373-bf66-4bfc-a4f8-3a35be5c2f9c"
        }
      }
    }
  }
}