Email Notifications

GET /metadata/email_notifications

The list of email notification types supported by Arta's API.

Headers

Authorization string Required

Authorize your API calls with an Arta API token

Responses

200 application/json

A collection of email notification types
Hide headers attributes Show headers attributes
- content-type string
- x-arta-request-id string
  
  A unique identifier for the Arta API call
Hide response attributes Show response attributes object
- description string
  
  A long form description
- id string
  
  The ID representing the resource
- name string
  
  A brief title for the resource
- optional_recipients array[string]
  
  The list of configurable recipients for this notification

GET /metadata/email_notifications

curl \
 -X GET https://api.arta.io/metadata/email_notifications \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"

Response examples (200)

# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
[
  {
    "description": "Delivered when a shipment is confirmed.",
    "id": "booking",
    "name": "Booking Confirmation",
    "optional_recipients": [
      "destination"
    ]
  }
]