Update an Email Rule

PATCH /email_rules/{email_rule_id}

Update an Email Rule request

Headers

Authorization string Required

Authorize your API calls with an Arta API token

Path parameters

email_rule_id integer Required

email_rule_id parameter

application/json

Body

email_rule object Required
Hide email_rule attribute Show email_rule attribute object
- recipients array[string] Required
  
  The list of recipients for this Email Rule.

Responses

200 application/json

The updated email rule
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
- created_at string
- email_notification_id string
- id integer
- recipients array[string]
- updated_at string
404 application/json

Not Found
Hide headers attributes Show headers attributes
- content-type string
- x-arta-request-id string
  
  A unique identifier for the Arta API call
Hide response attribute Show response attribute object
- errors object
  
  Hide errors attribute Show errors attribute object
  
  detail string

PATCH /email_rules/{email_rule_id}

curl \
 --request PATCH 'https://api.arta.io/email_rules/{email_rule_id}' \
 --header "Content-Type: application/json" \
 --header "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
 --data '{"email_rule":{"recipients":["destination","origin"]}}'

Request examples

# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y

# Payload
{
  "email_rule": {
    "recipients": [
      "destination",
      "origin"
    ]
  }
}

Response examples (200)

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

# Payload
{
  "created_at": "2021-10-27T16:48:38.657228",
  "email_notification_id": "complete",
  "id": 1942,
  "recipients": [
    "destination"
  ],
  "updated_at": "2021-10-27T16:48:38.657228"
}

Response examples (404)

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

# Payload
{
  "errors": {
    "detail": "string"
  }
}