Rivier/ Reference/ domains

Create or change a warmup plan (operator)

post/deliverability/warmup-plans

Create or change a warmup plan (operator). The volumes are the operator's numbers.

Before you call

Credential
Authorization: Bearer $KEY
Scope
domains:write
Graphql
Mutation.domainsDeliverabilityPlanSave
Sdk
domains.deliverabilityPlan.save
Cli
domains deliverability plan save

Request bodyapplication/json, required

  • idstring
    At most 80 characters.
  • namestringrequired
    At most 80 characters.
  • stageslist of objectrequired
    • dayintegerrequired
      At least 1.
    • domainVolumeintegerrequired
      At least 0.
    • ipVolumeintegerrequired
      At least 0.
  • afterLaststring
    One of: hold, unlimited.
  • notestring
    At most 300 characters.

Responses

  • 200application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown