Sign in

v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB
Subscribers

Update subscriber preferences

Update subscriber preferences by its unique key identifier subscriberId. workflowId is optional field, if provided, this API will update that workflow preference, otherwise it will update global preferences

patch/v2/subscribers/{subscriberId}/preferences

Path parameters

subscriberIdstring required

The identifier of the subscriber

Headers

idempotency-keystring

A header for idempotency purposes

Request body

workflowIdstring

Workflow internal _id, identifier or slug. If provided, update workflow specific preferences, otherwise update global preferences

contextobject

Example request

{
  "schedule": {
    "isEnabled": true,
    "weeklySchedule": {
      "monday": {
        "isEnabled": true,
        "hours": [
          {
            "start": "09:00 AM",
            "end": "05:00 PM"
          }
        ]
      },
      "tuesday": {
        "isEnabled": true,
        "hours": [
          {
            "start": "09:00 AM",
            "end": "05:00 PM"
          }
        ]
      },
      "wednesday": {
        "isEnabled": true,
        "hours": [
          {
            "start": "09:00 AM",
            "end": "05:00 PM"
          }
        ]
      },
      "thursday": {
        "isEnabled": true,
        "hours": [
          {
            "start": "09:00 AM",
            "end": "05:00 PM"
          }
        ]
      },
      "friday": {
        "isEnabled": true,
        "hours": [
          {
            "start": "09:00 AM",
            "end": "05:00 PM"
          }
        ]
      },
      "saturday": {
        "isEnabled": true,
        "hours": [
          {
            "start": "09:00 AM",
            "end": "05:00 PM"
          }
        ]
      },
      "sunday": {
        "isEnabled": true,
        "hours": [
          {
            "start": "09:00 AM",
            "end": "05:00 PM"
          }
        ]
      }
    }
  }
}

Response

OK

Example response

{
  "global": {
    "channels": {
      "email": true,
      "in_app": true,
      "push": true,
      "tool": true
    },
    "schedule": {
      "isEnabled": true,
      "weeklySchedule": {
        "monday": {
          "isEnabled": true,
          "hours": [
            {
              "start": "09:00 AM",
              "end": "05:00 PM"
            }
          ]
        },
        "tuesday": {
          "isEnabled": true,
          "hours": [
            {
              "start": "09:00 AM",
              "end": "05:00 PM"
            }
          ]
        },
        "wednesday": {
          "isEnabled": true,
          "hours": [
            {
              "start": "09:00 AM",
              "end": "05:00 PM"
            }
          ]
        },
        "thursday": {
          "isEnabled": true,
          "hours": [
            {
              "start": "09:00 AM",
              "end": "05:00 PM"
            }
          ]
        },
        "friday": {
          "isEnabled": true,
          "hours": [
            {
              "start": "09:00 AM",
              "end": "05:00 PM"
            }
          ]
        },
        "saturday": {
          "isEnabled": true,
          "hours": [
            {
              "start": "09:00 AM",
              "end": "05:00 PM"
            }
          ]
        },
        "sunday": {
          "isEnabled": true,
          "hours": [
            {
              "start": "09:00 AM",
              "end": "05:00 PM"
            }
          ]
        }
      }
    }
  },
  "workflows": [
    {
      "channels": {
        "email": true,
        "in_app": true,
        "push": true,
        "tool": true
      }
    }
  ]
}