Create an Email Subscription

POST /email_subscriptions

response

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

application/json

Body

  • Hide email_subscription attributes Show email_subscription attributes
    • The email_address for this Email Subscription.

    • The list of Email Notification IDs for this Email Subscription.

    • name string

      The name for this Email Subscription. This name will be used in conjunction with the email address field to build the recipient when delivering email notifications.

Responses

POST /email_subscriptions
curl \
 -X POST https://api.arta.io/email_subscriptions \
 -H "Content-Type: application/json" \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
 -d '{"email_subscription":{"email_address":"hello@shiparta.com","email_notification_ids":["booking","scheduling"],"name":"Arta"}}'
Request examples
# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y

# Payload
{
  "email_subscription": {
    "email_address": "hello@shiparta.com",
    "email_notification_ids": [
      "booking",
      "scheduling"
    ],
    "name": "Arta"
  }
}
Response examples (201)
{
  "id": 6,
  "name": "Arta Notifications",
  "created_at": "2020-10-14T15:25:48.298369",
  "updated_at": "2020-10-14T15:25:48.298369",
  "email_address": "notifications@shiparta.com",
  "email_notification_ids": [
    "booking",
    "complete",
    "scheduling"
  ]
}
Response examples (400)
{
  "errors": {
    "detail": "string"
  }
}