Contents x
    /membership/subscribe
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    /membership/subscribe

    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /membership/subscribe

    Subscribes a user to a group. With this call, the subscription is handled as a self subscription.
    Depending on the subscription mode used, the user may have to confirm the subscription (opt-in) and may be notified of the successful subscription.

    Query parameters
    userId
    integer (int64) Required

    ID of the user

    groupId
    integer (int64) Required

    ID of the group

    subscriptionMode
    stringRequired

    CONFIRMED_OPT_IN - New contacts receive a welcome message via email when they are added to the group. The contact does not need to confirm the subscription. A single opt-in subscription.
    DOUBLE_OPT_IN - New contacts receive an invitation to join the group via email. The contact must accept the invitation before they are added to the group. A double opt-in subscription
    OPT_IN - New contacts are added to the group without notification. OPT_IN is creating self-subscribers

    Valid values[ "CONFIRMED_OPT_IN", "DOUBLE_OPT_IN", "OPT_IN" ]
    Responses
    204
    400

    Parameter 'userId' is mandatory but no value was specified. / User with id does not exist.

    404

    Not found

    Was this article helpful?
    What's Next