Skip to content
Fromenance docsFromenance docs

Update a source

PATCH
/v1/sending-sources/{id}
curl --request PATCH \
  --url https://api.fromenance.com/v1/sending-sources/src_01J8Z9X0Q3K4M5N6P7R8S9T0V1 \
  --header 'Content-Type: application/json' \
  --cookie fromenance.session_token=<fromenance.session_token> \
  --data '{ "name": "example", "status": "active", "config": { "additionalProperty": "example" }, "expected_daily_volume": 1, "silence_alert_minutes": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
id
required
string
/^src_[0-9A-Z]{26}$/
Example
src_01J8Z9X0Q3K4M5N6P7R8S9T0V1

Request Body

Section titled “Request Body”
Media typeapplication/json
object
name
string
>= 1 characters <= 80 characters
status
string
Allowed values: active paused
config
object
key
additional properties
string
expected_daily_volume
integer | null
silence_alert_minutes
integer
>= 5 <= 20160

Responses

Section titled “ Responses ”

200

Section titled “200”

Source

Media typeapplication/json
object
id
required
string
name
required
string
kind
required
string
status
required
string
webhook_url
required
string | null
needs_reserve
required
boolean
footer_merge_tag
required
string | null
instructions
required
Array<string>
expected_daily_volume
required
integer | null
silence_alert_minutes
required
integer
health
required
object
last_event_at
required
string | null
events_last_hour
required
integer
signature_failures
required
integer
reserved
required
integer
completed
required
integer
reserve_to_complete_ratio
required
number | null
coverage_gaps
required
integer
silent
required
boolean
registered_today
required
integer
created_at
required
string
Examplegenerated
{
  "id": "example",
  "name": "example",
  "kind": "example",
  "status": "example",
  "webhook_url": "example",
  "needs_reserve": true,
  "footer_merge_tag": "example",
  "instructions": [
    "example"
  ],
  "expected_daily_volume": 1,
  "silence_alert_minutes": 1,
  "health": {
    "last_event_at": "example",
    "events_last_hour": 1,
    "signature_failures": 1,
    "reserved": 1,
    "completed": 1,
    "reserve_to_complete_ratio": 1,
    "coverage_gaps": 1,
    "silent": true,
    "registered_today": 1
  },
  "created_at": "example"
}