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

    /membership/subscribeByEmail

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

    Post
    /membership/subscribeByEmail

    Subscribes a recipient to a group.
    The recipient must exist in the system.

    Query parameters
    email
    stringRequired

    Email of the user.

    Attention! According to URL encoding some characters like "+", "[", "]" are need to be encode otherwise the request will fails. For example:

    name+surname@test.com should be encoded as name%2Bsurname@test.com

    name[surname@test.com should be encoded as name%5Bsurname@test.com

    name]surname@test.com should be encoded as name%5Dsurname@test.com

    groupId
    integer (int64) Required

    ID of the group

    Valid values[ 0-100 ]
    subscriptionMode
    stringRequired

    CONFIRMED_OPT_IN - New contacts receive a welcome message via email when they are added to the group. Despite the label used for this value, 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.

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

    Parameter 'email' is not a valid email address. / User with email does not exist. / Group with id is archived.

    404

    Error response: {
    "errorActor": "CLIENT",
    "errorCode": "INVALID_REQUEST",
    "message": "Not Found"
    }

    Was this article helpful?
    What's Next