/membership/subscribeByEmail
- 1 Minute to read
- Print
- DarkLight
/membership/subscribeByEmail
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Post
/membership/subscribeByEmail
Subscribes a recipient to a group.
The recipient must exist in the system.
Example:https://
Query parameters
email
stringRequired
Email of the user.
Important note! Some special characters in an email address must be URL encoded, such as the "+", "]" and "]" characters, 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
The "@" symbol used to separate the local part from the domain can be used with or without being URL encoded. Engage will accept both formats as the separator symbol. For example, both the following addresses are valid and identical for Engage: my.address@example.com or my.address%40example.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?