Dies sind für Webmaster gedachte, ergänzende Information, um das Opt-In-Formular in eine Webseite zu integrieren.
Hier haben wir für Sie unsere Subscription-API dokumentiert:
Parameter sind jeweils:
Die clientId (xx) und die listId (diese wird für jede Liste generiert).
Subscription DTO
{
"id" [INTEGER],
"status": [ENUM('pending', 'active', 'unsubscribed')],
"verifiedAt": [DATETIME],
"unsubscribedAt": [DATETIME],
"sourceObjectType": [ENUM('api', 'user', 'registrationForm', 'import', 'portal')],
"updatedAt": [DATETIME],
"createdAt": [DATETIME],
"subscriber": {
"id" [INTEGER],
"email": [STRING],
"personalSalutation": [STRING],
"academicTitle": [STRING],
"firstName": [STRING],
"lastName": [STRING],
"sex": [ENUM('M', 'F')],
"address": [STRING],
"zip": [STRING],
"city": [STRING],
"country": [STRING(3)],
"company": [STRING],
"department": [STRING],
"telephone": [STRING],
"mobilePhone": [STRING],
"twitterUsername": [STRING],
"instagramUsername": [STRING],
"snapchatUsername": [STRING],
"facebookUrl": [STRING],
"youtubeUrl": [STRING],
"xingUrl": [STRING],
"linkedinUrl": [STRING],
"blogUrl": [STRING],
"status": [ENUM('active', 'hardBounced')],
"hardBouncedAt": [DATETIME],
"updatedAt": [DATETIME],
"createdAt": [DATETIME]
}
}Requests
PUT /list/:listId/subscription/
Creates a single subscription by sending the object with mime type application/json in the request body.
Request body
{
"subscriber": {
"email": [STRING],
"personalSalutation": [STRING],
"academicTitle": [STRING],
"firstName": [STRING],
"lastName": [STRING],
"sex": [ENUM('M', 'F')],
"address": [STRING],
"zip": [STRING],
"city": [STRING],
"country": [STRING(3)],
"company": [STRING],
"department": [STRING],
"telephone": [STRING],
"mobilePhone": [STRING],
"twitterUsername": [STRING],
"instagramUsername": [STRING],
"snapchatUsername": [STRING],
"facebookUrl": [STRING],
"youtubeUrl": [STRING],
"xingUrl": [STRING],
"linkedinUrl": [STRING],
"blogUrl": [STRING]
},
"verifiedAt": [DATETIME],
"verifiedByUserId": [INTEGER],
"unsubscribedAt": [DATETIME],
"unsubscribedByUserId": [INTEGER]
}Response body
Subscription DTO
Example
Creating a subscription with the following values:
clientId=1
listId=6
curl -X PUT \
https://api.kulturkurier.de/list/6/subscription/ \
-H 'Content-Type: application/json' \
-d '{
"clientId": 1,
"subscriber": {
"email": "test@example.com"
}
}'