Sign in
Repeating Sends

Update a repeating send

Changed on

Pause, resume or cancel a repeat, or change its cadence, limits, message or whether the recipient may stop it. active resumes a paused repeat or one the recipient stopped; the next message goes out within about a minute. A null only_if_recipient_idle_minutes, max_sends or until clears that limit.

patch/repeating-sends/{id}

Request

  • Base URL: https://api.primitive.dev/v1
  • URL: https://api.primitive.dev/v1/repeating-sends/{id}
  • Auth: HTTP bearer

Request body

status'active' | 'paused' | 'canceled'
every_minutesinteger
only_if_recipient_idle_minutesinteger nullable
stoppable_by_recipientboolean
max_sendsinteger nullable
untilstring date-time nullable
body_textstring
subjectstring

Response

The updated repeating send

successboolean required

Changes

  • 52138fa51360Revision changes
    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

  • b8003b64c138Revision changes
    • info

      the request property's min was decreased from 5.00 to 1.00