{"swagger":"2.0","host":"rest.cleverreach.com","basePath":"","produces":["application\/json","application\/xml"],"consumes":["application\/json","application\/xml"],"paths":{"\/v3\/debug\/exchange":{"get":{"operationId":"debugExchange","tags":["debug"],"parameters":[],"summary":"Exchange token for a new token. \ud83d\udd10","description":" Exchange calling token with a new one. the old one will be invalid then.","responses":{"200":{"description":"Token","schema":{"type":"string"}},"500":{"description":"RestException"}},"security":[{"api_key":[]}]}},"\/v3\/debug\/ttl":{"get":{"operationId":"debugRetrieveTTL","tags":["debug"],"parameters":[],"summary":"Retrieve the ttl of the token. \ud83d\udd10","description":" Retrieve the ttl of the token","responses":{"200":{"description":"Token","schema":{"type":"string"}},"500":{"description":"RestException"}},"security":[{"api_key":[]}]}},"\/v3\/debug\/validate":{"get":{"operationId":"debugTokenValidation","tags":["debug"],"parameters":[],"summary":"Token validation. \ud83d\udd10","description":" Checks whether the calling token is still valid","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}},"500":{"description":"RestException"}},"security":[{"api_key":[]}]}},"\/v3\/clients":{"get":{"operationId":"listclient","tags":["clients"],"parameters":[{"name":"pagesize","type":"integer","format":"int64","defaultValue":50,"description":"max amount of entries per query","in":"query","required":false},{"name":"page","type":"integer","format":"int64","description":"page","in":"query","required":false}],"summary":"get clients. \ud83d\udd10","description":" returns a list of clients managed by this account. In case of a single client it returns a object","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/debug\/whoami":{"get":{"operationId":"clientWhoami","tags":["debug"],"parameters":[],"summary":"whoami. \ud83d\udd10","description":" Information about the current client","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/clients\/{id}\/plan":{"get":{"operationId":"clientPlan","tags":["clients"],"parameters":[{"name":"id","type":"string","description":"client_id","in":"path","required":true}],"summary":"get subscription\/plan info for one client. \ud83d\udd10","description":" get subscription\/plan info for one client","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/clients\/{id}\/limits":{"get":{"operationId":"clientLimits","tags":["clients"],"parameters":[{"name":"id","type":"string","description":"client_id","in":"path","required":true}],"summary":"get information about various account limits. \ud83d\udd10","description":"","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/clients\/{id}\/invoiceaddress":{"get":{"operationId":"clientInvoiceaddress","tags":["clients"],"parameters":[{"name":"id","type":"string","description":"client_id","in":"path","required":true}],"summary":"get current active invoice address. \ud83d\udd10","description":" get the current active invoice address for one client","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/clients\/{id}\/nextinvoicedate":{"get":{"operationId":"clientNextInvoiceDate","tags":["clients"],"parameters":[{"name":"id","type":"string","description":"client_id","in":"path","required":true}],"summary":"get next invoice date. \ud83d\udd10","description":" get the next invoice date as a timestamp","responses":{"200":{"description":"Success","schema":{"type":"integer","format":"int64"}}},"security":[{"api_key":[]}]}},"\/v3\/clients\/{id}\/contingent":{"get":{"operationId":"clientRetrieveContingent","tags":["clients"],"parameters":[{"name":"id","type":"string","description":"client_id","in":"path","required":true}],"summary":"get available contingent. \ud83d\udd10","description":" get the currently still available contignent of mails, free to send For flatrate this always returns 0.","responses":{"200":{"description":"Success","schema":{"type":"integer","format":"int64"}}},"security":[{"api_key":[]}]}},"\/v3\/clients\/{id}\/receivercount":{"get":{"operationId":"clientReceivercount","tags":["clients"],"parameters":[{"name":"id","type":"string","description":"client_id","in":"path","required":true}],"summary":"get receiver count for client. \ud83d\udd10","description":" get the amount of receivers of a certain client","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/clients\/{id}\/activereceivercount":{"get":{"operationId":"clientActivereceivercount","tags":["clients"],"parameters":[{"name":"id","type":"string","description":"client_id","in":"path","required":true}],"summary":"get active receiver count for client. \ud83d\udd10","description":" get only the amount of active receivers of a certain client","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/clients\/{id}":{"get":{"operationId":"retrieveclient","tags":["clients"],"parameters":[{"name":"id","type":"string","description":"client_id","in":"path","required":true}],"summary":"get info for one client. \ud83d\udd10","description":" get info for single client","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/clients\/domain\/{domain}":{"get":{"operationId":"clientRetrieveByDomain","tags":["clients"],"parameters":[{"name":"domain","type":"string","description":"client_domain","in":"path","required":true}],"summary":"get info for one client by given domain. \ud83d\udd10","description":" get info for single client by a given domain","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/clients\/{id}\/users":{"get":{"operationId":"clientUserlist","tags":["clients"],"parameters":[{"name":"id","type":"string","description":"client_id","in":"path","required":true}],"summary":"get userlist for one client. \ud83d\udd10","description":" get userlist for single client","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/blacklist":{"get":{"operationId":"listblacklist","tags":["blacklist"],"parameters":[],"summary":"get all blacklisted emails. \ud83d\udd10","description":" returns a list with all blacklisted email addresses","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]},"post":{"operationId":"createblacklist","tags":["blacklist"],"parameters":[{"name":"createblacklistModel","description":"**email** (required) \ncomment \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/createblacklistModel"}}],"summary":"add entry. \ud83d\udd10","description":" add a new email address to the blacklist Example Post Data:<\/strong> {     \"email\": \"ras@guhl.org\",     \"comment\": \"not to talk about\" } <\/code>","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]},"put":{"operationId":"updateblacklist","tags":["blacklist"],"parameters":[{"name":"updateblacklistModel","description":"**email** (required) \ncomment \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/updateblacklistModel"}}],"summary":"update entry. \ud83d\udd10","description":" updates an entry of the blacklist by email Example Post Data:<\/strong> {     \"email\": \"ras@guhl.org\",     \"comment\": \"really not to talk about\" } <\/code>","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/blacklist\/{email}":{"get":{"operationId":"retrieveblacklist","tags":["blacklist"],"parameters":[{"name":"email","type":"string","description":"email","in":"path","required":true}],"summary":"get info for blacklisted email. \ud83d\udd10","description":" get infos of a single blacklisted email address. You can use it to check if a email is on the blacklist.","responses":{"200":{"description":"or 404 if not on blacklist","schema":{"type":"string"}},"500":{"description":"RestException"}},"security":[{"api_key":[]}]},"delete":{"operationId":"removeblacklist","tags":["blacklist"],"parameters":[{"name":"email","type":"string","description":"email to be deleted","in":"path","required":true}],"summary":"delete blacklist entry. \ud83d\udd10","description":" delete an email address from blacklist","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/blacklist\/batch":{"post":{"operationId":"blacklistBatch","tags":["blacklist"],"parameters":[{"name":"blacklistBatchModel","description":"**items** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/blacklistBatchModel"}}],"summary":"add multiple entries. \ud83d\udd10","description":"","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}},"500":{"description":"RestException"}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/blacklist":{"get":{"operationId":"blacklistGroupBlacklist","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true}],"summary":"get blocklisted emails for group. \ud83d\udd10","description":" returns a list with all blocklisted email addresse for a group","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}},"500":{"description":"RestException"}},"security":[{"api_key":[]}]},"post":{"operationId":"blacklistGroupBlacklistAdd","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"group id","in":"path","required":true},{"name":"blacklistGroupBlacklistAddModel","description":"**email** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/blacklistGroupBlacklistAddModel"}}],"summary":"add email to group blocklist. \ud83d\udd10","description":" add a email address to group blocklist","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}},"500":{"description":"RestException"}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{id}\/blacklist\/{email}":{"delete":{"operationId":"blacklistGroupBlacklistRemove","tags":["groups"],"parameters":[{"name":"id","type":"string","description":"group id","in":"path","required":true},{"name":"email","type":"string","description":"email","in":"path","required":true}],"summary":"remove email from group blocklist. \ud83d\udd10","description":" removes email address from group blocklist","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}},"500":{"description":"RestException"}},"security":[{"api_key":[]}]}},"\/v3\/blacklist\/validate":{"post":{"operationId":"blacklistFilterEmailList","tags":["blacklist"],"parameters":[{"name":"blacklistFilterEmailListModel","description":"**emails** (required) \ngroup_id \ninvert \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/blacklistFilterEmailListModel"}}],"summary":"filter emails, get valid ones. \ud83d\udd10","description":" Filters provided list of emails and returns the not blacklisted ones Example Post Data:<\/strong> {     \"emails\": [         \"joker@blocklisted.com\",         \"robin@gotham.com\",         \"batman@gotham.com\"     ],     \"group_id\": \"11940\",     \"invert\": false } <\/code>","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/groups":{"get":{"operationId":"listgroup","tags":["groups"],"parameters":[{"name":"order","type":"string","description":"order by statement (created ASC or DESC, changed ASC or DESC)","in":"query","required":false}],"summary":"get list of groups (receiver lists). \ud83d\udd10","description":" returns array of groups (receiver lists)","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]},"post":{"operationId":"creategroup","tags":["groups"],"parameters":[{"name":"creategroupModel","description":"**name** (required) \nreceiver_info \nlocked \nbackup \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/creategroupModel"}}],"summary":"create group (receiver list). \ud83d\udd10","description":" create a list of receivers Example Post Data:<\/strong> {     \"name\": \"Justice League\",     \"receiver_info\": \"Superhero colleagues\",     \"locked\": false,     \"backup\": true } <\/code>","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{id}":{"get":{"operationId":"retrievegroup","tags":["groups"],"parameters":[{"name":"id","type":"string","description":"group id","in":"path","required":true}],"summary":"get group (receiver list) by id. \ud83d\udd10","description":" return group by given id","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]},"put":{"operationId":"updategroup","tags":["groups"],"parameters":[{"name":"id","type":"string","description":"id of group to be updated","in":"path","required":true},{"name":"updategroupModel","description":"name \nreceiver_info \nlocked \nbackup \n","in":"body","required":false,"schema":{"$ref":"#\/definitions\/updategroupModel"}}],"summary":"update group (receiver list). \ud83d\udd10","description":" update a list of receivers Example Post Data:<\/strong> {     \"name\": \"Justice League\",     \"receiver_info\": \"Superhero colleagues\",     \"locked\": false,     \"backup\": true } <\/code>","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]},"delete":{"operationId":"removegroup","tags":["groups"],"parameters":[{"name":"id","type":"string","description":"Group ID","in":"path","required":false}],"summary":"delete group (receiver list). \ud83d\udd10","description":" delete group (receiver list)","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{id}\/stats":{"get":{"operationId":"groupStats","tags":["groups"],"parameters":[{"name":"id","type":"string","description":"Group ID","in":"path","required":false}],"summary":"return group stats. \ud83d\udd10","description":" return stats about the group (receiver list)","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/advancedstats":{"get":{"operationId":"groupAdvstats","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true}],"summary":"return group advanced stats. \ud83d\udd10","description":" return extended stats about the group (receiver list)","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{id}\/clear":{"delete":{"operationId":"groupClear","tags":["groups"],"parameters":[{"name":"id","type":"string","description":"Group ID","in":"path","required":false}],"summary":"truncates group (receiver list). \ud83d\udd10","description":" delete all email addresses from group (receiver list)","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/forms":{"get":{"operationId":"listform","tags":["forms"],"parameters":[],"summary":"return list of forms. \ud83d\udd10","description":" return list of forms This endpoint is **deprecated**. For any new development and upcoming migrations, please use the new **flow** endpoints to prevent breaking changes in the future.","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}],"deprecated":true}},"\/v3\/forms\/{id}":{"get":{"operationId":"retrieveform","tags":["forms"],"parameters":[{"name":"id","type":"string","description":"id","in":"path","required":true}],"summary":"return form. \ud83d\udd10","description":" return a form This endpoint is **deprecated**. For any new development and upcoming migrations, please use the new **flow** endpoints to prevent breaking changes in the future.","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}],"deprecated":true},"delete":{"operationId":"removeform","tags":["forms"],"parameters":[{"name":"id","type":"string","description":"Form ID","in":"path","required":false}],"summary":"delete form. \ud83d\udd10","description":" delete form This endpoint is **deprecated**. For any new development and upcoming migrations, please use the new **flow** endpoints to prevent breaking changes in the future.","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}],"deprecated":true}},"\/v3\/groups\/{id}\/forms":{"get":{"operationId":"formForms","tags":["groups"],"parameters":[{"name":"id","type":"string","description":"Group ID","in":"path","required":false}],"summary":"return group forms. \ud83d\udd10","description":" return group forms This endpoint is **deprecated**. For any new development and upcoming migrations, please use the new **flow** endpoints to prevent breaking changes in the future.","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}],"deprecated":true}},"\/v3\/forms\/{id}\/code":{"get":{"operationId":"formRetrieveCode","tags":["forms"],"parameters":[{"name":"id","type":"string","description":"id","in":"path","required":true},{"name":"badget","type":"boolean","description":"Enable Badget (Disable only for non free plans) (default: false)","in":"query","required":false},{"name":"embedded","type":"boolean","description":"Embedded (default: false)","in":"query","required":false},{"name":"js","type":"boolean","defaultValue":true,"description":"Embedded JS (default: true)","in":"query","required":false},{"name":"css","type":"boolean","defaultValue":true,"description":"Embedded CSS (default: true)","in":"query","required":false}],"summary":"get embedded code. \ud83d\udd10","description":" return code for embedding Note:<\/strong> This Explorer unescapes the return values. Therefore it unescapes HTML from this endpoint! Your browser tries to display it, resulting in no result and seemingly endless loading. Please use this endpoint in your browser directly to try it. This endpoint is **deprecated**. For any new development and upcoming migrations, please use the new **flow** endpoints to prevent breaking changes in the future.","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}],"deprecated":true}},"\/v3\/forms\/{group_id}\/createfromtemplate\/{type}":{"post":{"operationId":"formCreateTemplateForm","tags":["forms"],"parameters":[{"name":"group_id","type":"string","description":"id of group to create the form for","in":"path","required":true},{"name":"type","type":"string","description":"type of the template","in":"path","required":true},{"name":"formCreateTemplateFormModel","description":"**extradata** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/formCreateTemplateFormModel"}}],"summary":"create form from template. \ud83d\udd10","description":" Creates a form from a template by given type Example Post Data (extradata for type 'default'):<\/strong> {     \"name\": \"Form for Batnews\",     \"title\": \"Batnews\" } <\/code> You should specify a name and a title. If no name is given, the title is taken. 400 if you don't specify anything. This endpoint is **deprecated**. For any new development and upcoming migrations, please use the new **flow** endpoints to prevent breaking changes in the future.","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}],"deprecated":true}},"\/v3\/forms\/{form_id}\/send\/{type}":{"post":{"operationId":"formSendMail","tags":["forms"],"parameters":[{"name":"form_id","type":"string","description":"id","in":"path","required":true},{"name":"type","type":"string","enum":["activate","deactivate"],"description":"type of email","in":"path","required":true},{"name":"formSendMailModel","description":"**email** (required) \n**doidata** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/formSendMailModel"}}],"summary":"send subscribe\/unsubscribe mail. \ud83d\udd10","description":" send subscribe\/unsubscribe mail to one of your receivers Example Post Data:<\/strong> {     \"email\": \"alfred.pennyworth@gotham.com\",     \"doidata\": {         \"user_ip\": \"1.2.3.4\",         \"referer\": \"http:\/\/www.wayne-enterprises.com\",         \"user_agent\": \"Brucilla\/1.0 (HerOS\/Linux)\"     } } <\/code> This endpoint is **deprecated**. For any new development and upcoming migrations, please use the new **flow** endpoints to prevent breaking changes in the future.","responses":{"200":{"description":"Success","schema":{"type":"boolean"}}},"security":[{"api_key":[]}],"deprecated":true}},"\/v3\/groups\/{group_id}\/attributes":{"get":{"operationId":"attributeList_grp","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"ID of the group","in":"path","required":true}],"summary":"return local attributes. \ud83d\udd10","description":" return local attributes.","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]},"post":{"operationId":"attributeCreate_groups","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"ID of group","in":"path","required":true},{"name":"attributeCreate_groupsModel","description":"**name** (required) \n**type** (required) \ndescription \npreview_value \ndefault_value \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/attributeCreate_groupsModel"}}],"summary":"create attribute. \ud83d\udd10","description":" create attribute Example Post Data:<\/strong> {     \"name\": \"secret_id\",     \"type\": \"text\",     \"description\": \"Secret identity\",     \"preview_value\": \"real name\",     \"default_value\": \"Bruce Wayne\" } <\/code>","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/attributes":{"get":{"operationId":"listattribute","tags":["attributes"],"parameters":[{"name":"group_id","type":"string","description":"ID of the group - leave empty for global attributes","in":"query","required":false}],"summary":"return attributes. \ud83d\udd10","description":" return local or global attributes","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]},"post":{"operationId":"createattribute","tags":["attributes"],"parameters":[{"name":"createattributeModel","description":"**name** (required) \n**type** (required) \ngroup_id \ndescription \npreview_value \ndefault_value \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/createattributeModel"}}],"summary":"create attribute. \ud83d\udd10","description":" create attribute Example Post Data:<\/strong> {     \"name\": \"secret_id\",     \"type\": \"text\",     \"description\": \"Secret identity\",     \"group_id\": \"1939\",     \"preview_value\": \"real name\",     \"default_value\": \"Bruce Wayne\" } <\/code>","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/attributes\/{id}":{"get":{"operationId":"retrieveattribute","tags":["attributes"],"parameters":[{"name":"id","type":"string","description":"id","in":"path","required":true}],"summary":"return attribute. \ud83d\udd10","description":" return a attribute","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]},"put":{"operationId":"attributeUpdate_attr","tags":["attributes"],"parameters":[{"name":"id","type":"string","description":"Attribute ID","in":"path","required":true},{"name":"attributeUpdate_attrModel","description":"type \ndescription \npreview_value \ngroup_id \n","in":"body","required":false,"schema":{"$ref":"#\/definitions\/attributeUpdate_attrModel"}}],"summary":"update attribute. \ud83d\udd10","description":" update attribute","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]},"delete":{"operationId":"removeattribute","tags":["attributes"],"parameters":[{"name":"id","type":"string","description":"Attribute ID","in":"path","required":true}],"summary":"delete attribute. \ud83d\udd10","description":" delete attribute","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/attributes\/{id}":{"put":{"operationId":"attributeUpdate_grps","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"group id","in":"path","required":true},{"name":"id","type":"string","description":"Attribute ID","in":"path","required":true},{"name":"attributeUpdate_grpsModel","description":"type \ndescription \npreview_value \n","in":"body","required":false,"schema":{"$ref":"#\/definitions\/attributeUpdate_grpsModel"}}],"summary":"update attribute. \ud83d\udd10","description":" update attribute","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]},"delete":{"operationId":"attributeRemove_grps","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"id","type":"string","description":"Attribute ID","in":"path","required":true}],"summary":"delete attribute. \ud83d\udd10","description":" delete attribute","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/{id}\/attributes":{"get":{"operationId":"attributeRetrievePoolAttributes","tags":["receivers"],"parameters":[{"name":"id","type":"string","description":"ID or email of receiver","in":"path","required":true},{"name":"group_id","type":"string","description":"Group ID (optional)","in":"query","required":false}],"summary":"get attributes of receiver. \ud83d\udd10","description":" get attributes of receiver","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/{pool_id}\/attributes\/{id}":{"put":{"operationId":"attributeSavePoolAttribute_groups","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"pool_id","type":"string","description":"ID or Email address","in":"path","required":true},{"name":"id","type":"string","description":"Attribute ID","in":"path","required":true},{"name":"attributeSavePoolAttribute_groupsModel","description":"**value** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/attributeSavePoolAttribute_groupsModel"}}],"summary":"update value of an attribute of a receiver. \ud83d\udd10","description":" update value of an attribute of a receiver","responses":{"200":{"description":"Success","schema":{"type":"boolean"}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/{pool_id}\/attributes\/{id}":{"put":{"operationId":"attributeSavePoolAttribute_receivers","tags":["receivers"],"parameters":[{"name":"pool_id","type":"string","description":"ID or Email address","in":"path","required":true},{"name":"id","type":"string","description":"Attribute ID","in":"path","required":true},{"name":"attributeSavePoolAttribute_receiversModel","description":"**value** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/attributeSavePoolAttribute_receiversModel"}}],"summary":"update value of an attribute of a receiver. \ud83d\udd10","description":" update value of an attribute of a receiver","responses":{"200":{"description":"Success","schema":{"type":"boolean"}}},"security":[{"api_key":[]}]}},"\/v3\/attributes\/limits":{"get":{"operationId":"attributeLimits","tags":["attributes"],"parameters":[],"summary":"get attribute limits. \ud83d\udd10","description":" show the attribute limits applied to the account","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/filters":{"get":{"operationId":"listfilter","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"","in":"path","required":false}],"summary":"return filter. \ud83d\udd10","description":" return filter","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]},"post":{"operationId":"filterCreateFilter","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"group ID","in":"path","required":true},{"name":"filterCreateFilterModel","description":"**name** (required) \n**rules** (required) \noperator \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/filterCreateFilterModel"}}],"summary":"creates a filter\/segment. \ud83d\udd10","description":" creates a filter\/segment Example Post Data:<\/strong> {     \"name\": \"My Filter\",     \"operator\": \"OR\",     \"rules\": [         { \"field\":\"email\", \"logic\":\"contains\", \"condition\":\"@gotham.com\" },         { \"field\":\"activated\", \"logic\":\"bg\", \"condition\":\"1234567\" },         { \"field\":\"firstname\", \"logic\":\"eq\", \"condition\":\"bruce\" },         { \"field\":\"lastname\", \"logic\":\"eq\", \"condition\":\"wayne\" }     ] } <\/code> Possible Operators<\/strong>
  1. OR<\/li>
  2. AND (default)<\/li> <\/ol> Available Logics:<\/strong>
    1. eq - equals<\/small><\/li>
    2. neq - not equals<\/small><\/li>
    3. sm - smaller<\/small><\/li>
    4. bg - bigger<\/small><\/li>
    5. isnull - is empty<\/small><\/li>
    6. notisnull - not empty<\/small><\/li>
    7. contains - contains given string<\/small><\/li>
    8. begins - begins with<\/small><\/li>
    9. ends - ends with<\/small><\/li>
    10. ismale - given field is male<\/small><\/li>
    11. isfemale - given field is female<\/small><\/li> <\/ol> general available fields:<\/strong>
      1. email - (email of the receiver)<\/small><\/li>
      2. source - (import source of the email)<\/small><\/li>
      3. imported - (timestamp of receiver import)<\/small><\/li>
      4. registered - (timestamp of receiver registration)<\/small><\/li>
      5. activated - (timestamp of receiver activation)<\/small><\/li>
      6. deactivated - (timestamp of receiver deactivation)<\/small><\/li>
      7. bounced - (timestamp of receiver bounce)<\/small><\/li>
      8. points - (points of the receiver)<\/small><\/li>
      9. last_location - (last location of receiver)<\/small><\/li>
      10. last_client - (last mail client used by receiver)<\/small><\/li>
      11. crevent_mail_send (logic: eq, condition: mailing_id -> receiver of certain mailing)<\/li>
      12. crevent_mail_open (logic: eq, condition: mailing_id -> opened mail of certain mailing)<\/li>
      13. crevent_mail_click (logic: eq, condition: mailing_id -> clicked on mail of certain mailing)<\/li>
      14. crevent_mail_bounce (logic: eq, condition: mailing_id -> bounced mail of certain mailing)<\/li>
      15. all attributes (if global and group attributes have the same name, group ones will be favoured)<\/li> <\/ol> ","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/filters\/{filter_id}":{"get":{"operationId":"retrievefilter","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":false},{"name":"filter_id","type":"string","description":"Filter ID","in":"path","required":false}],"summary":"get filter. \ud83d\udd10","description":" get filter","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]},"put":{"operationId":"filterUpdateFilter","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"group ID","in":"path","required":true},{"name":"filter_id","type":"string","description":"filter ID","in":"path","required":true},{"name":"filterUpdateFilterModel","description":"name \nrules \noperator \n","in":"body","required":false,"schema":{"$ref":"#\/definitions\/filterUpdateFilterModel"}}],"summary":"updates a filter\/segment. \ud83d\udd10","description":" updates a filter\/segment Example Post Data:<\/strong> {     \"name\": \"My Filter\",     \"operator\": \"OR\",     \"rules\": [         { \"field\":\"email\", \"logic\":\"contains\", \"condition\":\"@gotham.com\" },         { \"field\":\"activated\", \"logic\":\"bg\", \"condition\":\"1234567\" },         { \"field\":\"firstname\", \"logic\":\"eq\", \"condition\":\"brooze\" },         { \"field\":\"lastname\", \"logic\":\"eq\", \"condition\":\"vain\" }     ] } <\/code> Possible Operators<\/strong>
        1. OR<\/li>
        2. AND (default)<\/li> <\/ol> Available Logics:<\/strong>
          1. eq - equals<\/small><\/li>
          2. neq - not equals<\/small><\/li>
          3. sm - smaller<\/small><\/li>
          4. bg - bigger<\/small><\/li>
          5. isnull - is empty<\/small><\/li>
          6. notisnull - not empty<\/small><\/li>
          7. contains - contains given string<\/small><\/li>
          8. begins - begins with<\/small><\/li>
          9. ends - ends with<\/small><\/li>
          10. ismale - given field is male<\/small><\/li>
          11. isfemale - given field is female<\/small><\/li> <\/ol> general available fields:<\/strong>
            1. email - (email of the receiver)<\/small><\/li>
            2. source - (import source of the email)<\/small><\/li>
            3. imported - (timestamp of receiver import)<\/small><\/li>
            4. registered - (timestamp of receiver registration)<\/small><\/li>
            5. activated - (timestamp of receiver activation)<\/small><\/li>
            6. deactivated - (timestamp of receiver deactivation)<\/small><\/li>
            7. bounced - (timestamp of receiver bounce)<\/small><\/li>
            8. points - (points of the receiver)<\/small><\/li>
            9. last_location - (last location of receiver)<\/small><\/li>
            10. last_client - (last mail client used by receiver)<\/small><\/li>
            11. crevent_mail_send (logic: eq, condition: mailing_id -> receiver of certain mailing)<\/li>
            12. crevent_mail_open (logic: eq, condition: mailing_id -> opened mail of certain mailing)<\/li>
            13. crevent_mail_click (logic: eq, condition: mailing_id -> clicked on mail of certain mailing)<\/li>
            14. crevent_mail_bounce (logic: eq, condition: mailing_id -> bounced mail of certain mailing)<\/li>
            15. all attributes (if global and group attributes have the same name, group ones will be favoured)<\/li> <\/ol> ","responses":{"200":{"description":"success","schema":{"type":"boolean"}}},"security":[{"api_key":[]}]},"delete":{"operationId":"filterRemoveFilter","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"group ID","in":"path","required":true},{"name":"filter_id","type":"string","description":"filter ID","in":"path","required":true}],"summary":"deletes a filter\/segment. \ud83d\udd10","description":" deletes a filter\/segment","responses":{"200":{"description":"success","schema":{"type":"boolean"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/filters\/{filter_id}\/stats":{"get":{"operationId":"filterFilterStats","tags":["groups"],"parameters":[{"name":"filter_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"group_id","type":"string","description":"Filter ID","in":"path","required":false}],"summary":"return groups statistics based on a Filter. \ud83d\udd10","description":" return groups statistics based on a Filter","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/filters\/{filter_id}\/count":{"get":{"operationId":"filterFilterPoolCount","tags":["groups"],"parameters":[{"name":"filter_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"group_id","type":"string","description":"Filter ID","in":"path","required":false}],"summary":"return groups statistics based on a Filter. \ud83d\udd10","description":" return groups statistics based on a Filter","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/filter":{"post":{"operationId":"filterRuntimeFilter","tags":["receivers"],"parameters":[{"name":"filterRuntimeFilterModel","description":"**rules** (required) \ngroups \noperator \norderby \ndetail \npagesize \npage \nactiveonly \nlast_poolid \ninactive_events \nsuper_tags \nfast_mode \ndebug \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/filterRuntimeFilterModel"}}],"summary":"get recievers by runtime filter. \ud83d\udd10","description":" returns a list of receivers, filtered by a temporary filter Example Post Data:<\/strong> {    \"groups\": [\"1\",\"2\",\"3\"],    \"operator\": \"OR\",    \"rules\": [       { \"field\":\"email\", \"logic\":\"contains\", \"condition\":\"@gotham.com\" },       { \"field\":\"activated\", \"logic\":\"bg\", \"condition\":\"1234567\" },       { \"field\":\"firstname\", \"logic\":\"eq\", \"condition\":\"bruce\" },       { \"field\":\"lastname\", \"logic\":\"eq\", \"condition\":\"gordon\" }    ],    \"orderby\": \"activated desc\",    \"detail\": 0,    \"pagesize\": 250,    \"page\": 0 } <\/code> Available Logics<\/strong>
              1. eq  (equals)<\/li>
              2. neq  (not equals)<\/li>
              3. sm  (smaller)<\/li>
              4. bg  (bigger)<\/li>
              5. isnull  (is empty)<\/li>
              6. notisnull  (not empty)<\/li>
              7. contains  (contains given string)<\/li>
              8. begins  (begins with)<\/li>
              9. ends  (ends with)<\/li>
              10. ismale  (given field is male)<\/li>
              11. isfemale  (given field is female)<\/li> <\/ol> General available fields<\/strong>
                1. email - (email of the receiver)<\/small><\/li>
                2. source - (import source of the email)<\/small><\/li>
                3. imported - (timestamp of receiver import)<\/small><\/li>
                4. registered - (timestamp of receiver registration)<\/small><\/li>
                5. activated - (timestamp of receiver activation)<\/small><\/li>
                6. deactivated - (timestamp of receiver deactivation)<\/small><\/li>
                7. bounced - (timestamp of receiver bounce)<\/small><\/li>
                8. points - (points of the receiver)<\/small><\/li>
                9. last_location - (last location of receiver)<\/small><\/li>
                10. last_client - (last mail client used by receiver)<\/small><\/li>
                11. crevent_mail_send (logic: eq, condition: mailing_id -> receiver of certain mailing)<\/li>
                12. crevent_mail_open (logic: eq, condition: mailing_id -> opened mail of certain mailing)<\/li>
                13. crevent_mail_click (logic: eq, condition: mailing_id -> clicked on mail of certain mailing)<\/li>
                14. crevent_mail_bounce (logic: eq, condition: mailing_id -> bounced mail of certain mailing)<\/li>
                15. all attributes (if global and group attributes have the same name, group ones will be favoured)<\/li> <\/ol> ","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/filters\/{filter_id}\/receivers":{"get":{"operationId":"receiverList_filter","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"filter_id","type":"string","description":"Filter ID","in":"path","required":true},{"name":"pagesize","type":"integer","format":"int64","defaultValue":50,"description":"Pagesize (max 5000)","in":"query","required":false},{"name":"page","type":"integer","format":"int64","description":"Page (zero-based)","in":"query","required":false},{"name":"type","type":"string","defaultValue":"all","enum":["all","active","inactive","bounce"],"description":"Type","in":"query","required":false},{"name":"detail","type":"integer","format":"int64","description":"Detail depth (bitwise combinable) (0: none, 1: events, 2: orders, 4: tags)","in":"query","required":false},{"name":"email_list","type":"string","description":"list of Receiver Emails's to filter for. comma separated like: \"foo@bar.com,bar@foo.com,...\"","in":"query","required":false},{"name":"id_list","type":"string","description":"list of Receiver ID's to filter for. comma separated like: \"123,633,5342\"","in":"query","required":false},{"name":"order_by","type":"string","description":"field to order by, append 'asc' or 'desc' with a space","in":"query","required":false}],"summary":"return receivers. \ud83d\udd10","description":" return a list of receivers","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers":{"get":{"operationId":"receiverList_groups","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"pagesize","type":"integer","format":"int64","defaultValue":50,"description":"Pagesize (max 5000)","in":"query","required":false},{"name":"page","type":"integer","format":"int64","description":"Page (zero-based)","in":"query","required":false},{"name":"type","type":"string","defaultValue":"all","enum":["all","active","inactive","bounce"],"description":"Type","in":"query","required":false},{"name":"detail","type":"integer","format":"int64","description":"Detail depth (bitwise combinable) (0: none, 1: events, 2: orders, 4: tags)","in":"query","required":false},{"name":"email_list","type":"string","description":"list of receiver emails to filter for. Comma separated like: \"foo@bar.com,bar@foo.com,...\"","in":"query","required":false},{"name":"id_list","type":"string","description":"list of Receiver ID's to filter for. comma separated like: \"123,633,5342\"","in":"query","required":false},{"name":"order_by","type":"string","description":"field to order by, append 'asc' or 'desc' with a space","in":"query","required":false}],"summary":"return receivers. \ud83d\udd10","description":" return a list of receivers","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]},"post":{"operationId":"createreceiver","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"createreceiverModel","description":"**postdata** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/createreceiverModel"}}],"summary":"create new receiver. \ud83d\udd10","description":" create a new receiver Carefully use the fields 'registered', 'activated' and 'deactivated': - provide 'registered' with current time if receiver is new. - provide 'activated' only for immedite activation (no DOI mail will work then). - provide 'deactivated' other than 0 and your receiver will definitely be inactive. Omission of all of those fields leads to an activated receiver ('registered' and 'activated' to current time)! Example Post Data:<\/strong> {     \"email\":\"bruce@gotham.com\",     \"registered\": \"1118354400\",     \"activated\": \"1118354400\", \/\/ omit if receiver is to be activated later, e.g. DOI mail     \"deactivated\": \"0\", \/\/ omit field unless you know what you are doing!     \"source\":\"Batcave Computer\",     \"attributes\": {         \"is_batman\":\"1\"     },     \"global_attributes\": {         \"firstname\":\"Bruce\",         \"lastname\":\"Wayne\"     },     \"tags\": [ \"hero\", \"rich\", \"smart\" ],     \"orders\": [         {             \"order_id\": \"xyz123412\",             \"product_id\": \"SN9876543\",             \"product\": \"Batman - The Movie (DVD)\",             \"price\": 9.99,             \"currency\": \"EUR\",             \"quantity\": 1,             \"mailing_id\": \"12345678\"         },         {             \"order_id\": \"xyz123411\",             \"product_id\": \"SN9876542\",             \"product\": \"Batman - The Soundtrack (CD)\",             \"price\": 9.99,             \"currency\": \"EUR\",             \"quantity\": 1,             \"mailing_id\": \"12345678\"         }     ] } <\/code>","responses":{"200":{"description":"the created receiver","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/get_receivers":{"post":{"operationId":"receiverList_groups","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"receiverList_groupsModel","description":"pagesize \npage \ntype \ndetail \nemail_list \nid_list \norder_by \n","in":"body","required":false,"schema":{"$ref":"#\/definitions\/receiverList_groupsModel"}}],"summary":"return receivers. \ud83d\udd10","description":" return a list of receivers","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/{pool_id}":{"get":{"operationId":"receiverRetrieve_groups","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"ID of the group","in":"path","required":true},{"name":"pool_id","type":"string","description":"ID or email of the receiver","in":"path","required":true}],"summary":"return receiver. \ud83d\udd10","description":" return specific receiver of a certain group","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]},"delete":{"operationId":"removereceiver","tags":["groups"],"parameters":[{"name":"pool_id","type":"string","description":"ID or email of the receiver","in":"path","required":true},{"name":"group_id","type":"string","description":"Group ID","in":"path","required":false}],"summary":"delete receiver. \ud83d\udd10","description":" Delete a receiver by id","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/{id}":{"put":{"operationId":"updatereceiver","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"ID of the group","in":"path","required":true},{"name":"id","type":"string","description":"ID or email of receiver","in":"path","required":true},{"name":"updatereceiverModel","description":"**postdata** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/updatereceiverModel"}}],"summary":"update receiver. \ud83d\udd10","description":" Update any information of a receiver Please note that you can not change the email!<\/strong> Carefully use the fields 'registered', 'activated' and 'deactivated': - provide 'registered' with current time if receiver is new. - provide 'activated' only for immedite activation (no DOI mail will work then). - provide 'deactivated' other than 0 and your receiver will definitely be inactive. 0 will eventually reactivate receivers! Just omit 'deactivated' unless you know, what you are doing! Example Post Data:<\/strong> {     \"registered\": \"1118354400\", \/\/ usually not needed to be set on update     \"activated\": \"1118354400\", \/\/ only use to immediately activate the receiver     \"deactivated\": \"0\", \/\/ omit field unless you know what you are doing!     \"source\": \"Batcave Computer\",     \"attributes\": {         \"is_batman\":\"1\"     },     \"global_attributes\": {         \"firstname\":\"Bruce\",         \"lastname\":\"Wayne\"     },     \"tags\": [ \"hero\", \"rich\", \"smart\" ],     \"orders\": [         {             \"order_id\": \"xyz123412\",             \"product_id\": \"SN9876543\",             \"product\": \"Batman - The Movie (DVD)\",             \"price\": 9.99,             \"currency\": \"EUR\",             \"quantity\": 1,             \"mailing_id\": \"12345678\"         },         {             \"order_id\": \"xyz123411\",             \"product_id\": \"SN9876542\",             \"product\": \"Batman - The Soundtrack (CD)\",             \"price\": 9.99,             \"currency\": \"EUR\",             \"quantity\": 1,             \"mailing_id\": \"12345678\"         }     ] } <\/code> ","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/{id}":{"get":{"operationId":"retrievereceiver","tags":["receivers"],"parameters":[{"name":"id","type":"string","description":"ID or email of the receiver","in":"path","required":true},{"name":"group_id","type":"string","description":"ID of group for group specific information","in":"query","required":false}],"summary":"return receiver. \ud83d\udd10","description":" return certain receiver Use group id for retrieving group specific information. If you do not specify any group id, all group specific information will be empty. ","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/{pool_id}":{"delete":{"operationId":"removereceiver","tags":["receivers"],"parameters":[{"name":"pool_id","type":"string","description":"ID or email of the receiver","in":"path","required":true},{"name":"group_id","type":"string","description":"Group ID","in":"query","required":false}],"summary":"delete receiver. \ud83d\udd10","description":" Delete a receiver by id","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/tags":{"get":{"operationId":"receiverRetrieveTagsList","tags":["receivers"],"parameters":[{"name":"origin","type":"string","description":"(optional) filter by tag origin","in":"query","required":false}],"summary":"get list of already set tags. \ud83d\udd10","description":" returns a list of already set tags To only get tags of a certain origin, specify that accordingly. Use * for any origin or leave blank for no origin. ","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/{id}\/tags":{"get":{"operationId":"receiverRetrieveTags","tags":["receivers"],"parameters":[{"name":"id","type":"string","description":"ID or email of the receiver","in":"path","required":true},{"name":"origin","type":"string","description":"(optional) filter by tag origin. use '*' for any origin.","in":"query","required":false}],"summary":"get set tags of certain receivers. \ud83d\udd10","description":" returns all currently set tags of a certain receiver To only get tags of a certain origin, specify that accordingly. ","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]},"post":{"operationId":"receiverAddTags","tags":["receivers"],"parameters":[{"name":"id","type":"string","description":"ID or email of the receiver","in":"path","required":true},{"name":"receiverAddTagsModel","description":"**tags** (required) \ngroup_id \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/receiverAddTagsModel"}}],"summary":"Add receiver tags. \ud83d\udd10","description":" adds given tags to receiver only allowed characters are \/[a-zA-Z0-9_\\\\-\\\\p{L}]+\/u<\/code> that's basicly all latin characters including a few kyrilic ones all other characters are replaces by underscore. You can prefix an origin to a tag with a following period. Example: origin.tagname The following rules apply to tag origins: - everything before the first found period is considered an origin - it is cut to 50 characters length - it may use the same characterset as a tag - it may be used multiple times of course (see example) Example post Data:<\/strong> {   \"tags\": [\"batman.Good\",batman.DarkKnight\",\"joker.evil\",\"joker.fakeSmile\",\"robin\",\"alfred\"],   \"group_id\": \"1966\" } <\/code> returns a list of actual added tags. Note:<\/strong> You will not trigger THEA without a group id!","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/{id}\/tags":{"post":{"operationId":"receiverAddTags","tags":["groups"],"parameters":[{"name":"id","type":"string","description":"ID or email of the receiver","in":"path","required":true},{"name":"group_id","type":"string","description":"(optional) ID of the group","in":"path","required":false},{"name":"receiverAddTagsModel","description":"**tags** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/receiverAddTagsModel"}}],"summary":"Add receiver tags. \ud83d\udd10","description":" adds given tags to receiver only allowed characters are \/[a-zA-Z0-9_\\\\-\\\\p{L}]+\/u<\/code> that's basicly all latin characters including a few kyrilic ones all other characters are replaces by underscore. You can prefix an origin to a tag with a following period. Example: origin.tagname The following rules apply to tag origins: - everything before the first found period is considered an origin - it is cut to 50 characters length - it may use the same characterset as a tag - it may be used multiple times of course (see example) Example post Data:<\/strong> {   \"tags\": [\"batman.Good\",batman.DarkKnight\",\"joker.evil\",\"joker.fakeSmile\",\"robin\",\"alfred\"],   \"group_id\": \"1966\" } <\/code> returns a list of actual added tags. Note:<\/strong> You will not trigger THEA without a group id!","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/{id}\/tags\/{tags}":{"delete":{"operationId":"receiverRemoveTags","tags":["receivers"],"parameters":[{"name":"id","type":"string","description":"ID or email of the receiver","in":"path","required":true},{"name":"tags","type":"string","description":"tag or comma separated tags to be removed","in":"path","required":true}],"summary":"removes receiver tags. \ud83d\udd10","description":" removes the given tags from a certain receiver provide one or more tags comma separated to delete all tags of one origin, just use wildcard: myorigin.*","responses":{"200":{"description":"Success","schema":{"type":"boolean"}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/tags\/{origin}":{"delete":{"operationId":"receiverRemoveAllTagsByOrigin","tags":["receivers"],"parameters":[{"name":"origin","type":"string","description":"origin to be removed","in":"path","required":true}],"summary":"remove tags by origin (experimental feature). \ud83d\udd10","description":" remove tags by origin from ALL receivers","responses":{"200":{"description":"Success","schema":{"type":"boolean"}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/{id}\/groups":{"get":{"operationId":"receiverRetrieveGroups","tags":["receivers"],"parameters":[{"name":"id","type":"string","description":"ID or email of the receiver","in":"path","required":true},{"name":"state","type":"string","defaultValue":"all","enum":["all","active","inactive"],"description":"state of the receiver within the group","in":"query","required":false}],"summary":"gets list of groups the receiver is in. \ud83d\udd10","description":" Retrieves an array of groups the given receiver is allocated to","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/{pool_id}\/deactivate":{"put":{"operationId":"receiverSetInactive","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"pool_id","type":"string","description":"ID or email of the receiver","in":"path","required":true}],"summary":"deactivates receiver. \ud83d\udd10","description":" set receiver status to not active","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/{id}\/activate":{"put":{"operationId":"receiverSetActive","tags":["groups"],"parameters":[{"name":"id","type":"string","description":"ID or Email of the receiver","in":"path","required":true},{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true}],"summary":"activates receiver. \ud83d\udd10","description":" set receiver status to active","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/upsert":{"post":{"operationId":"receiverUpsert","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"receiverUpsertModel","description":"**postdata** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/receiverUpsertModel"}}],"summary":"update or create multiple receivers. \ud83d\udd10","description":" Updates receivers or creates new ones, if email not existing Carefully use the fields 'registered', 'activated' and 'deactivated': - provide 'registered' with current time if receiver is new. - provide 'activated' only for immedite activation (no DOI mail will work then). - provide 'deactivated' other than 0 and your receiver will definitely be inactive. 0 will eventually reactivate receivers! Omission of all of those fields leads to an activated receiver, if new ('registered' and 'activated' to current time)! Example Post Data:<\/strong> [     {         \"email\":\"bruce@gotham.com\",         \"registered\": \"1118354400\",         \"activated\": \"1118354400\", \/\/ omit if receiver is to be activated later, e.g. DOI mail         \"source\":\"Batcave Computer\",         \"attributes\": {             \"is_batman\":\"1\"         },         \"global_attributes\": {             \"firstname\":\"Bruce\",             \"lastname\":\"Wayne\"         },         \"tags\": [ \"hero\", \"rich\", \"smart\" ],         \"orders\": [             {                 \"order_id\": \"xyz123412\",                 \"product_id\": \"SN9876543\",                 \"product\": \"Batman - The Movie (DVD)\",                 \"price\": 9.99,                 \"currency\": \"EUR\",                 \"quantity\": 1,                 \"mailing_id\": \"12345678\"             },             {                 \"order_id\": \"xyz123411\",                 \"product_id\": \"SN9876542\",                 \"product\": \"Batman - The Soundtrack (CD)\",                 \"price\": 9.99,                 \"currency\": \"EUR\",                 \"quantity\": 1,                 \"mailing_id\": \"12345678\"             }         ]      }     , { ... additional user ... } ] <\/code>","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/update":{"put":{"operationId":"receiverUpdate","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"receiverUpdateModel","description":"**postdata** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/receiverUpdateModel"}}],"summary":"update multiple receivers. \ud83d\udd10","description":" Updates receivers if email existing Carefully use the fields 'registered', 'activated' and 'deactivated': - provide 'registered' with current time if receiver is new. - provide 'activated' only for immedite activation (no DOI mail will work then). - provide 'deactivated' other than 0 and your receiver will definitely be inactive. 0 will eventually reactivate receivers! Just omit 'deactivated' unless you know, what you are doing! Example Post Data:<\/strong> [     {         \"email\":\"bruce@gotham.com\",         \"registered\": \"1118354400\",         \"activated\": \"1118354400\", \/\/ omit if receiver is to be activated later, e.g. DOI mail         \"source\":\"Batcave Computer\",         \"attributes\": {             \"is_batman\":\"1\"         },         \"global_attributes\": {             \"firstname\":\"Bruce\",             \"lastname\":\"Wayne\"         },         \"tags\": [ \"hero\", \"rich\", \"smart\" ],         \"orders\": [             {                 \"order_id\": \"xyz123412\",                 \"product_id\": \"SN9876543\",                 \"product\": \"Batman - The Movie (DVD)\",                 \"price\": 9.99,                 \"currency\": \"EUR\",                 \"quantity\": 1,                 \"mailing_id\": \"12345678\"             },             {                 \"order_id\": \"xyz123411\",                 \"product_id\": \"SN9876542\",                 \"product\": \"Batman - The Soundtrack (CD)\",                 \"price\": 9.99,                 \"currency\": \"EUR\",                 \"quantity\": 1,                 \"mailing_id\": \"12345678\"             }         ]      }     , { ... additional user ... } ] <\/code>","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/updateplus":{"put":{"operationId":"receiverUpdateplus","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"receiverUpdateplusModel","description":"**postdata** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/receiverUpdateplusModel"}}],"summary":"update multiple receivers. \ud83d\udd10","description":" This is just like update, except you can increase or decrease numeric attribute values. Prepend a \"+\" or \"-\" to the value to increase or decrease a value. You also can manipulate TAGS in a similar way: In the array of tags, prepend a \"-\" to the tag you want to be removed. To remove all tags with a specific origin, simply specify \"*\" instead of any tag name. Carefully use the fields 'registered', 'activated' and 'deactivated': - provide 'registered' with current time if receiver is new. - provide 'activated' only for immedite activation (no DOI mail will work then). - provide 'deactivated' other than 0 and your receiver will definitely be inactive. 0 will eventually reactivate receivers! Just omit 'deactivated' unless you know, what you are doing! Example Post Data:<\/strong> [     {         \"email\":\"bruce@gotham.com\",         \"attributes\": {             \"weapons\":\"-4\"         },         \"global_attributes\": {             \"title\":\"winner\",             \"fights\":\"+1\",             \"enemies\":\"-1\"         },         \"tags\": [ \"winner\", \"-loser\", \"-joker.*\" ]      } ] <\/code>","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/upsertplus":{"post":{"operationId":"receiverUpsertplus","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"receiverUpsertplusModel","description":"**postdata** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/receiverUpsertplusModel"}}],"summary":"update\/create receivers and manipulate data. \ud83d\udd10","description":" This is just like upsert, except you can increase or decrease numeric attribute values. Prepend a \"+\" or \"-\" to the value to increase or decrease a value. You also can manipulate TAGS in a similar way: In the array of tags, prepend a \"-\" to the tag you want to be removed. To remove all tags with a specific origin, simply specify \"*\" instead of any tag name. Carefully use the fields 'registered', 'activated' and 'deactivated': - provide 'registered' with current time if receiver is new. - provide 'activated' only for immedite activation (no DOI mail will work then). - provide 'deactivated' other than 0 and your receiver will definitely be inactive. 0 will eventually reactivate receivers! Just omit 'deactivated' unless you know, what you are doing! Example Post Data:<\/strong> [     {         \"email\":\"bruce@gotham.com\",         \"attributes\": {             \"weapons\":\"-4\"         },         \"global_attributes\": {             \"title\":\"winner\",             \"fights\":\"+1\",             \"enemies\":\"-1\"         },         \"tags\": [ \"winner\", \"-loser\", \"-joker.*\" ]      } ] <\/code>","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/insert":{"post":{"operationId":"receiverInsert","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"receiverInsertModel","description":"**postdata** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/receiverInsertModel"}}],"summary":"create multiple receivers. \ud83d\udd10","description":" create multiple receivers Carefully use the fields 'registered', 'activated' and 'deactivated': - provide 'registered' with current time if receiver is new. - provide 'activated' only for immedite activation (no DOI mail will work then). - provide 'deactivated' other than 0 and your receiver will definitely be inactive. Omission of all of those fields leads to an activated receiver ('registered' and 'activated' to current time)! Example Post Data:<\/strong> [     {         \"email\":\"bruce@gotham.com\",         \"registered\": \"1118354400\",         \"activated\": \"1118354400\", \/\/ omit if receiver is to be activated later, e.g. DOI mail         \"deactivated\": \"0\",         \"source\":\"Batcave Computer\",         \"attributes\": {             \"is_batman\":\"1\"         },         \"global_attributes\": {             \"firstname\":\"Bruce\",             \"lastname\":\"Wayne\"         },         \"tags\": [ \"hero\", \"rich\", \"smart\" ],         \"orders\": [             {                 \"order_id\": \"xyz123412\",                 \"product_id\": \"SN9876543\",                 \"product\": \"Batman - The Movie (DVD)\",                 \"price\": 9.99,                 \"currency\": \"EUR\",                 \"quantity\": 1,                 \"mailing_id\": \"12345678\"             },             {                 \"order_id\": \"xyz123411\",                 \"product_id\": \"SN9876542\",                 \"product\": \"Batman - The Soundtrack (CD)\",                 \"price\": 9.99,                 \"currency\": \"EUR\",                 \"quantity\": 1,                 \"mailing_id\": \"12345678\"             }         ]     },     {         \"email\":\"damian@gotham.com\"     } ] <\/code>","responses":{"200":{"description":"the created receiver","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/{id}\/clone":{"post":{"operationId":"receiverCloneReceiver","tags":["receivers"],"parameters":[{"name":"id","type":"string","description":"ID or email of the receiver to be cloned","in":"path","required":true},{"name":"receiverCloneReceiverModel","description":"**email** (required) \n**target_group_id** (required) \noverwrite \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/receiverCloneReceiverModel"}}],"summary":"clone receiver and change email. \ud83d\udd10","description":" Copies a receiver and changes the email within the copy.","responses":{"200":{"description":"Success","schema":{"type":"boolean"}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/bounced":{"get":{"operationId":"receiverRetrieveBounces","tags":["receivers"],"parameters":[{"name":"limit","type":"integer","format":"int64","defaultValue":500,"description":"how many receivers to get","in":"query","required":false},{"name":"page","type":"integer","format":"int64","description":"which page to get","in":"query","required":false}],"summary":"get all bounced receivers. \ud83d\udd10","description":" get a paginated list of receivers with a bounce date","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/{id}\/email":{"put":{"operationId":"receiverChangeEmail","tags":["receivers"],"parameters":[{"name":"id","type":"string","description":"ID or email of the receiver to be modified","in":"path","required":true},{"name":"receiverChangeEmailModel","description":"**email** (required) \noverwrite \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/receiverChangeEmailModel"}}],"summary":"change email of a certain receiver. \ud83d\udd10","description":" Changes the email of a certain receiver","responses":{"200":{"description":"Success","schema":{"type":"boolean"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/delete":{"post":{"operationId":"receiverRemoveMultiple_group","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"receiverRemoveMultiple_groupModel","description":"**receivers** (required) \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/receiverRemoveMultiple_groupModel"}}],"summary":"delete multiple receivers. \ud83d\udd10","description":" Delete receivers by given ids or emails. Example Post Data:<\/strong> [     \"381940\",     \"dick.grayson@wayne.com\",     \"robin@gotham.com\",     \"3571983\" ] <\/code>","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/delete":{"post":{"operationId":"receiverRemoveMultiple","tags":["receivers"],"parameters":[{"name":"receiverRemoveMultipleModel","description":"**receivers** (required) \ngroup_id \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/receiverRemoveMultipleModel"}}],"summary":"delete multiple receivers. \ud83d\udd10","description":" Delete receivers by given list of ids of emails Example Post Data:<\/strong> {     \"receivers\": [         \"381940\",         \"dick.grayson@wayne.com\",         \"robin@gotham.com\",         \"3571983\"     ],     \"group_id\": 271939 } <\/code>","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/isvalid":{"post":{"operationId":"receiverIsvalid","tags":["receivers"],"parameters":[{"name":"receiverIsvalidModel","description":"**emails** (required) \ngroup_id \ninvert \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/receiverIsvalidModel"}}],"summary":"validate list of emails. \ud83d\udd10","description":" Submit a list of emails and return the valid ones. Returns the not blacklisted emails of given list. If group_id is set, the active state is checked additionally. Example Post Data:<\/strong> {     \"emails\": [         \"joker@arkham.com\",         \"twoface@dent.com\",         \"batman@gotham.com\"     ],     \"group_id\": \"1939\",     \"invert\": false } <\/code>","responses":{"200":{"description":"list email addresses","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/mailings\/{id}\/randomreceiver":{"get":{"operationId":"receiverRetrieveRandomReceiver","tags":["mailings"],"parameters":[{"name":"id","type":"string","description":"mailing id","in":"path","required":true}],"summary":"returns random receiver. \ud83d\udd10","description":" get random receiver for a mailing for preview reasons","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/mycontent":{"get":{"operationId":"listmycontent","tags":["mycontent"],"parameters":[],"summary":"gets my content items. \ud83d\udd10","description":" gets a list of all \"my content\" items","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]},"post":{"operationId":"createmycontent","tags":["mycontent"],"parameters":[{"name":"createmycontentModel","description":"**name** (required) \n**url** (required) \npassword \ntype \ncors \nicon \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/createmycontentModel"}}],"summary":"adds a \"my content\" item. \ud83d\udd10","description":" adds a new \"my content\" item","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/mycontent\/{id}":{"get":{"operationId":"retrievemycontent","tags":["mycontent"],"parameters":[{"name":"id","type":"string","description":"id of the item to get","in":"path","required":true}],"summary":"gets certain my content item. \ud83d\udd10","description":" gets a certain \"my content\" item by id","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]},"put":{"operationId":"updatemycontent","tags":["mycontent"],"parameters":[{"name":"id","type":"string","description":"id of the item to be modified","in":"path","required":true},{"name":"updatemycontentModel","description":"name \nurl \npassword \ntype \ncors \nicon \n","in":"body","required":false,"schema":{"$ref":"#\/definitions\/updatemycontentModel"}}],"summary":"edits \"my content\" items. \ud83d\udd10","description":" modifies an existing \"my content\" item","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]},"delete":{"operationId":"removemycontent","tags":["mycontent"],"parameters":[{"name":"id","type":"string","description":"Content ID","in":"path","required":true}],"summary":"delete my content. \ud83d\udd10","description":" delete my content","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/{pool_id}\/events":{"get":{"operationId":"listevent","tags":["receivers"],"parameters":[{"name":"pool_id","type":"string","description":"ID or email of receiver","in":"path","required":true},{"name":"group_id","type":"string","description":"Group ID","in":"query","required":false}],"summary":"return events of a receiver. \ud83d\udd10","description":" return a list of events for a receiver","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]},"post":{"operationId":"eventReceivers_create","tags":["receivers"],"parameters":[{"name":"pool_id","type":"string","description":"ID of the receiver","in":"path","required":true},{"name":"eventReceivers_createModel","description":"**value** (required) \ngroup_id \ntype \ntype_id \nmailing_id \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/eventReceivers_createModel"}}],"summary":"Adds an event to a reveiver. \ud83d\udd10","description":" Adds an event to a reveiver Example Post Data:<\/strong> {     \"type\": \"log\",     \"group_id\": \"42\",     \"value\": \"Entered the bat cave\",     \"type_id\": \"1939\",     \"mailing_id\": \"28\" } <\/code>","responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/event"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/{pool_id}\/events":{"get":{"operationId":"eventList_groups","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"pool_id","type":"string","description":"ID or email of receiver","in":"path","required":true}],"summary":"return events of a receiver. \ud83d\udd10","description":" return a list of events for a receiver","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]},"post":{"operationId":"createevent","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"ID of the group","in":"path","required":true},{"name":"pool_id","type":"string","description":"ID or email of the receiver","in":"path","required":true},{"name":"createeventModel","description":"**value** (required) \ntype \ntype_id \nmailing_id \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/createeventModel"}}],"summary":"Adds an event to a reveiver. \ud83d\udd10","description":" Adds an event to a reveiver Example Post Data:<\/strong> {     \"type\": \"log\",     \"value\": \"Entered the bat cave\",     \"type_id\": \"1939\",     \"mailing_id\": \"28\" } <\/code>","responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/event"}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/{pool_id}\/orders":{"get":{"operationId":"orderList_groups","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"ID of group","in":"path","required":true},{"name":"pool_id","type":"string","description":"ID or email of receiver","in":"path","required":true}],"summary":"return orders. \ud83d\udd10","description":" return a list of orders","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]},"post":{"operationId":"orderCreate_group","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"pool_id","type":"string","description":"ID or email of receiver","in":"path","required":true},{"name":"orderCreate_groupModel","description":"**order_id** (required) \n**product** (required) \nproduct_id \nstamp \nprice \nquantity \nmailing_id \nsource \ncurrency \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/orderCreate_groupModel"}}],"summary":"add orderitem. \ud83d\udd10","description":" adds orderitem Example Post Data:<\/strong> {     \"order_id\": \"19891990\",     \"product\": \"Batman: The Video Game\",     \"product_id\": \"jnr-1989-1990\",     \"price\": 1.99,     \"quantity\": 2,     \"source\": \"fanshop-gotham\",     \"currency\": \"USD\" } <\/code> ","responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/order"}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/{id}\/orders":{"get":{"operationId":"listorder","tags":["receivers"],"parameters":[{"name":"id","type":"string","description":"ID or email of receiver","in":"path","required":true},{"name":"group_id","type":"string","description":"ID of group - leave blank for global orders","in":"query","required":false}],"summary":"return orders. \ud83d\udd10","description":" return a list of orders","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/{pool_id}\/orders":{"post":{"operationId":"createorder","tags":["receivers"],"parameters":[{"name":"pool_id","type":"string","description":"ID or email of receiver","in":"path","required":true},{"name":"createorderModel","description":"**order_id** (required) \n**product** (required) \ngroup_id \nproduct_id \nstamp \nprice \nquantity \nmailing_id \nsource \ncurrency \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/createorderModel"}}],"summary":"add orderitem. \ud83d\udd10","description":" adds orderitem Example Post Data:<\/strong> {     \"order_id\": \"19891990\",     \"product\": \"Batman: The Video Game\",     \"product_id\": \"jnr-1989-1990\",     \"price\": 1.99,     \"quantity\": 2,     \"source\": \"fanshop-gotham\",     \"currency\": \"USD\" } <\/code> ","responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/order"}}},"security":[{"api_key":[]}]}},"\/v3\/mailings\/{id}\/orders":{"get":{"operationId":"orderRetrieveByMailing","tags":["mailings"],"parameters":[{"name":"id","type":"string","description":"Report\/MailingID","in":"path","required":true}],"summary":"return orders. \ud83d\udd10","description":" return a list of orders","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/groups\/{group_id}\/receivers\/{pool_id}\/orders\/{id}":{"put":{"operationId":"orderUpdate_groups","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"pool_id","type":"string","description":"ID or email of receiver","in":"path","required":true},{"name":"id","type":"string","description":"ID of the order","in":"path","required":true},{"name":"orderUpdate_groupsModel","description":"**product** (required) \nproduct_id \nstamp \nprice \nquantity \nmailing_id \nsource \ncurrency \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/orderUpdate_groupsModel"}}],"summary":"update orderitem. \ud83d\udd10","description":" updates orderitem Example Post Data:<\/strong> {     \"product\": \"Batman: The Video Game\",     \"product_id\": \"jnr-1989-1990\",     \"price\": 1.99,     \"quantity\": 2,     \"source\": \"fanshop-gotham\",     \"currency\": \"USD\" } <\/code> ","responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/order"}}},"security":[{"api_key":[]}]},"delete":{"operationId":"orderRemove_groups","tags":["groups"],"parameters":[{"name":"group_id","type":"string","description":"Group ID","in":"path","required":true},{"name":"pool_id","type":"string","description":"ID or email of receiver","in":"path","required":true},{"name":"id","type":"string","description":"ID of the order","in":"path","required":true}],"summary":"delete orderitem. \ud83d\udd10","description":" deletes orderitem","responses":{"200":{"description":"Success","schema":{"type":"boolean"}}},"security":[{"api_key":[]}]}},"\/v3\/receivers\/{pool_id}\/orders\/{id}":{"put":{"operationId":"updateorder","tags":["receivers"],"parameters":[{"name":"pool_id","type":"string","description":"ID or email of receiver","in":"path","required":true},{"name":"id","type":"string","description":"ID of the order","in":"path","required":true},{"name":"updateorderModel","description":"**product** (required) \nproduct_id \ngroup_id \nstamp \nprice \nquantity \nmailing_id \nsource \ncurrency \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/updateorderModel"}}],"summary":"update orderitem. \ud83d\udd10","description":" updates orderitem Example Post Data:<\/strong> {     \"product\": \"Batman: The Video Game\",     \"product_id\": \"jnr-1989-1990\",     \"price\": 1.99,     \"quantity\": 2,     \"source\": \"fanshop-gotham\",     \"currency\": \"USD\" } <\/code> ","responses":{"200":{"description":"Success","schema":{"$ref":"#\/definitions\/order"}}},"security":[{"api_key":[]}]},"delete":{"operationId":"removeorder","tags":["receivers"],"parameters":[{"name":"pool_id","type":"string","description":"ID or email of receiver","in":"path","required":true},{"name":"id","type":"string","description":"ID of the order","in":"path","required":true}],"summary":"delete orderitem. \ud83d\udd10","description":" deletes orderitem","responses":{"200":{"description":"Success","schema":{"type":"boolean"}}},"security":[{"api_key":[]}]}},"\/v3\/mailings":{"get":{"operationId":"listmailing","tags":["mailings"],"parameters":[{"name":"limit","type":"integer","format":"int64","defaultValue":25,"description":"number of items (max 1000; max 100 when state is not 'all')","in":"query","required":false},{"name":"state","type":"string","defaultValue":"all","enum":["all","finished","draft","waiting","running","automation"],"description":"state of mailing","in":"query","required":false},{"name":"channel_id","type":"string","description":"(optional): if specified, it will only return matching results","in":"query","required":false},{"name":"start","type":"integer","format":"int64","description":"(optional) Filter by start time (see note)","in":"query","required":false},{"name":"end","type":"integer","format":"int64","description":"(optional) Filter by end time (see note)","in":"query","required":false},{"name":"page","type":"integer","format":"int64","description":"(optional) page number, 0-based; only effective when state is not 'all'","in":"query","required":false}],"summary":"return lists of mailings. \ud83d\udd13","description":" returns lists of mailings according to following filter settings NOTE:<\/strong> The start<\/code> and end<\/code> fields depend on the state<\/code> field.   - finished mails are filtered by finished time   - draft mails are filtered by creation time   - waiting mails are filtered by the time they will be sent   - running mails are filtered by the time they have been started","responses":{"200":{"description":"List of mailings","schema":{"type":"array","items":{"type":"string"}}}}},"post":{"operationId":"createmailing","tags":["mailings"],"parameters":[{"name":"createmailingModel","description":"**name** (required) \n**subject** (required) \n**sender_name** (required) \n**sender_email** (required) \ncontent \nreceivers \nsettings \ntags \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/createmailingModel"}}],"summary":"create a mailing. \ud83d\udd13","description":" create a new mailing Example Post Data:<\/strong> {     \"name\": \"my internal name\",     \"subject\": \"subject line\",     \"sender_name\": \"Bruce Wayne (Wayne corp.)\",     \"sender_email\": \"bruce.wayne@gotham.com\",     \"content\": {         \"type\": \"html\/text\",  \/\/ \"html\", \"text\" or \"html\/text\"         \"html\": \"<html><body>The two faces of Harvey Dent<\/body><\/html>\",         \"text\": \"The two faces of Harvey Dent\"     },     \"receivers\": {  \/\/ fill either a list of group ids or a filter id         \"groups\": [ \"31939\", \"81942\" ],         \"filter\": \"66\"     },     \"settings\": {         \"editor\": \"wizard\",  \/\/ \"wizard\", \"freeform\", \"advanced\", \"plaintext\"         \"open_tracking\": true,  \/\/ track opening of emails         \"click_tracking\": true,  \/\/ track clicks of emails         \"link_tracking_url\": \"27.wayne.cleverreach.com\",         \"link_tracking_type\": \"google\",  \/\/ \"google\", \"intelliad\", \"crconnect\"         \"google_campaign_name\": \"My Campaign\",  \/\/ in case of link_tracking_type == \"google\"         \"unsubscribe_form_id\": \"23\",         \"category_id\": \"54\"     } } <\/code> Note:<\/strong> For links not to be substituted by tracking links, use 'single quotes' around urls in your html. ","responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"\/v3\/mailings\/{id}":{"get":{"operationId":"retrievemailing","tags":["mailings"],"parameters":[{"name":"id","type":"string","description":"mailing id","in":"path","required":true}],"summary":"return mailing. \ud83d\udd13","description":" get a mailing by id","responses":{"200":{"description":"Success","schema":{"type":"string"}}}},"put":{"operationId":"updatemailing","tags":["mailings"],"parameters":[{"name":"id","type":"string","description":"ID of the mailing","in":"path","required":true},{"name":"updatemailingModel","description":"name \nsubject \nsender_name \nsender_email \ncontent \nreceivers \nsettings \ntags \n","in":"body","required":false,"schema":{"$ref":"#\/definitions\/updatemailingModel"}}],"summary":"update a mailing. \ud83d\udd13","description":" update a mailing Example Post Data:<\/strong> {     \"name\": \"my new name\",     \"subject\": \"different subject line\",     \"sender_name\": \"Not Bruce Wayne (Wayne corp.)\",     \"sender_email\": \"not.bruce.wayne@gotham.com\",     \"content\": {         \"type\": \"html\/text\",  \/\/ \"html\", \"text\" or \"html\/text\"         \"html\": \"<html><body>The two faces of Harvey Dent<\/body><\/html>\",         \"text\": \"The two faces of Harvey Dent\"     },     \"receivers\": {  \/\/ fill either a list of group ids or a filter id         \"groups\": [ \"31939\", \"81942\" ],         \"filter\": \"66\"     },     \"settings\": {         \"editor\": \"advanced\",  \/\/ \"wizard\", \"freeform\", \"advanced\", \"plaintext\"         \"open_tracking\": true,  \/\/ track opening of emails         \"click_tracking\": true,  \/\/ track clicks of emails         \"link_tracking_url\": \"27.wayne.cleverreach.com\",         \"link_tracking_type\": \"google\",  \/\/ \"google\", \"intelliad\", \"crconnect\"         \"google_campaign_name\": \"My Campaign\",  \/\/ in case of link_tracking_type == \"google\"         \"unsubscribe_form_id\": \"23\",         \"category_id\": \"54\"     } } <\/code>","responses":{"200":{"description":"Success","schema":{"type":"boolean"}}}}},"\/v3\/mailings\/{id}\/links":{"get":{"operationId":"mailingRetrieveLinks","tags":["mailings"],"parameters":[{"name":"id","type":"string","description":"mailing id","in":"path","required":true}],"summary":"returns links for a mailing. \ud83d\udd13","description":" get links for a mailing by id","responses":{"200":{"description":"Success","schema":{"type":"string"}}}}},"\/v3\/mailings\/{id}\/sendpreview":{"post":{"operationId":"mailingSendPreview","tags":["mailings"],"parameters":[{"name":"id","type":"string","description":"ID of the mailing","in":"path","required":true},{"name":"mailingSendPreviewModel","description":"**receivers** (required) \npreviewText \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/mailingSendPreviewModel"}}],"summary":"sends a preview mail. \ud83d\udd13","description":" sends a preview mail of mailing with given id Only emails of users from logged in client can be used as receivers Example Post Data:<\/strong> {     \"receivers\": [         \"dick.grayson@gotham.com\",         \"jason.todd@gotham.com\",         \"tim.drake@gotham.com\",         \"damian.wayne@gotham.com\",         \"terry.mcginnis@gotham.com\"     ],     \"previewText\": \" - have a look\" } <\/code> If you do not provide a preview Text it is set to \" - PREVIEW\"! ","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}}}},"\/v3\/mailings\/template":{"post":{"operationId":"mailingCreateTemplate","tags":["mailings"],"parameters":[{"name":"mailingCreateTemplateModel","description":"**name** (required) \n**html** (required) \ntags \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/mailingCreateTemplateModel"}}],"summary":"create a template. \ud83d\udd13","description":" create a new template Example Post Data:<\/strong> {     \"name\": \"my internal name\",     \"html\": \"<html><body>The two faces of Harvey Dent<\/body><\/html>\" } <\/code> ","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}}}},"\/v3\/mailings\/templates\/agency":{"get":{"operationId":"mailingRetrieveAgencyTemplates","tags":["mailings"],"parameters":[],"summary":"return agency templates. \ud83d\udd13","description":" returns agency templates, if there are any","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}}}},"\/v3\/mailings\/templates\/user":{"get":{"operationId":"mailingRetrieveUserTemplates","tags":["mailings"],"parameters":[],"summary":"return user templates. \ud83d\udd13","description":" returns user templates, if there are any","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}}}},"\/v3\/reports":{"get":{"operationId":"listreport","tags":["reports"],"parameters":[{"name":"pagesize","type":"integer","format":"int64","defaultValue":50,"description":"max items","in":"query","required":false},{"name":"page","type":"integer","format":"int64","description":"page (max 10000)","in":"query","required":false},{"name":"channel_id","type":"string","description":"optional: if specified, it will only return matching results","in":"query","required":false},{"name":"start","type":"integer","format":"int64","description":"start date (unix timestamp), requires end date","in":"query","required":false},{"name":"end","type":"integer","format":"int64","description":"end date (unix timestamp), requires start date","in":"query","required":false},{"name":"group_id","type":"string","description":"get only reports for this group ID","in":"query","required":false},{"name":"mode","type":"string","defaultValue":"full","description":"response size [full, basic]","in":"query","required":false}],"summary":"get reports. \ud83d\udd10","description":" Get all reports Splittest reports always contain their versions as complete reports in an additional array field \"versions\".","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/reports\/{id}":{"get":{"operationId":"retrievereport","tags":["reports"],"parameters":[{"name":"id","type":"string","description":"Report ID\/Mailing ID","in":"path","required":true}],"summary":"get report. \ud83d\udd10","description":" Get a certain report Splittest reports always contain their versions as complete reports in an additional array field \"versions\". Do not call versions of a splittest directly! If you do so, you will get an error (403) containing the parent id to be called instead.","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]},"delete":{"operationId":"removereport","tags":["reports"],"parameters":[{"name":"id","type":"string","description":"Report ID\/Mailing ID","in":"path","required":true}],"summary":"delete report. \ud83d\udd10","description":" Delete certain report Note:<\/strong> All contained links, including unsubscription, will stop working!","responses":{"200":{"description":"Success","schema":{"type":"boolean"}}},"security":[{"api_key":[]}]}},"\/v3\/reports\/{id}\/stats\/{mode}":{"get":{"operationId":"reportStats","tags":["reports"],"parameters":[{"name":"id","type":"string","description":"ID of Report\/Mailing","in":"path","required":true},{"name":"mode","type":"string","defaultValue":"full","enum":["full","clients","mediaclients","countries","quality","firsthours","traffic","daily","links","conversion","custom"],"description":"Mode of statistics","in":"path","required":false},{"name":"start","type":"string","description":"Startdate unixtimestamp (only for mode daily)","in":"query","required":false},{"name":"end","type":"string","description":"Enddate unixtimestamp (only for mode daily)","in":"query","required":false}],"summary":"get stats. \ud83d\udd10","description":" Get statistics for a certain report For splittest versions request statistics seperately.","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/reports\/{id}\/receivers\/{state}":{"get":{"operationId":"reportUserReceived","tags":["reports"],"parameters":[{"name":"id","type":"string","description":"Report ID\/Mailing ID","in":"path","required":true},{"name":"state","type":"string","enum":["sent","opened","clicked","notopened","notclicked","bounced","unsubscribed"],"description":"State to get","in":"path","required":true},{"name":"linkid","type":"string","description":"ID of link that was clicked on","in":"query","required":false},{"name":"from","type":"integer","format":"int64","description":"Timestamp of earliest event of state","in":"query","required":false},{"name":"to","type":"integer","format":"int64","description":"Timestamp of latest event of state","in":"query","required":false},{"name":"detail","type":"integer","format":"int64","description":"Detail depth (bitwise combinable) (0: none, 1: events, 2: orders, 4: tags)","in":"query","required":false},{"name":"pagesize","type":"integer","format":"int64","defaultValue":50,"description":"Max items","in":"query","required":false},{"name":"page","type":"integer","format":"int64","description":"Page","in":"query","required":false}],"summary":"get infos about receivers. \ud83d\udd10","description":" Get informations about receivers For splittests versions request informations seperately.","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/mailings\/channel":{"get":{"operationId":"listcategories","tags":["mailings"],"parameters":[],"summary":"get list of channel. \ud83d\udd10","description":" returns array of categories","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/mailings\/channel\/{id}":{"get":{"operationId":"retrievecategories","tags":["mailings"],"parameters":[{"name":"id","type":"string","description":"id","in":"path","required":true}],"summary":"specific category. \ud83d\udd10","description":" specific category","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]},"delete":{"operationId":"removecategories","tags":["mailings"],"parameters":[{"name":"id","type":"string","description":"id","in":"path","required":false}],"summary":"deletes Category. \ud83d\udd10","description":" deletes Category","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/tags":{"get":{"operationId":"tagRetrieveTags","tags":["tags"],"parameters":[{"name":"group_id","type":"string","description":"group id to filter","in":"query","required":false},{"name":"origin","type":"string","description":"origin to filter. Leave empty for tags without origin, give \"*\" for any origin.","in":"query","required":false},{"name":"order_by","type":"string","defaultValue":"tag","enum":["tag","origin","count"],"description":"field to order by","in":"query","required":false},{"name":"limit","type":"integer","format":"int64","defaultValue":20,"description":"number of tags to get","in":"query","required":false},{"name":"page","type":"integer","format":"int64","description":"the page\/offset","in":"query","required":false}],"summary":"get tags. \ud83d\udd10","description":" Get tags given whithin calling account ","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/tags\/super":{"get":{"operationId":"tagRetrievePrioTags","tags":["tags"],"parameters":[{"name":"group_id","type":"string","description":"group id to filter","in":"query","required":false},{"name":"get_count","type":"boolean","description":"get count for each tag\/source","in":"query","required":false}],"summary":"get supertags. \ud83d\udd10","description":" Get supertags ","responses":{"200":{"description":"Success","schema":{"type":"string"}}},"security":[{"api_key":[]}]}},"\/v3\/tags\/count":{"get":{"operationId":"tagRetrieveReceiverCount","tags":["tags"],"parameters":[{"name":"tag","type":"string","description":"tag to get the counts for","in":"query","required":true},{"name":"group_id","type":"string","description":"group id to filter, leave blank (or choose 0) for all groups","in":"query","required":false},{"name":"except","type":"string","description":"tags (comma separated) that eventual receivers must not have","in":"query","required":false},{"name":"active","type":"boolean","description":"only retrieve active receivers","in":"query","required":false}],"summary":"get count of receivers with a certain tag. \ud83d\udd10","description":" Get the count of receivers with a certain tag ","responses":{"200":{"description":"Success","schema":{"type":"integer","format":"int64"}}},"security":[{"api_key":[]}]},"post":{"operationId":"tagRetrieveReceiverCountComplex","tags":["tags"],"parameters":[{"name":"tagRetrieveReceiverCountComplexModel","description":"**tags** (required) \ngroup_id \n","in":"body","required":true,"schema":{"$ref":"#\/definitions\/tagRetrieveReceiverCountComplexModel"}}],"summary":"get count of receivers with tag constellation. \ud83d\udd10","description":" Get the count of receivers with a certain set of tags ","responses":{"200":{"description":"Success","schema":{"type":"integer","format":"int64"}}},"security":[{"api_key":[]}]}},"\/v3\/oauth\/token":{"delete":{"operationId":"oauthHarakiri","tags":["oauth"],"parameters":[],"summary":"delete calling token. \ud83d\udd10","description":" deletes the calling oauth token. that will definitely be the last call with that token!<\/strong>","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}},"\/v3\/bounces":{"get":{"operationId":"listbounces","tags":["bounces"],"parameters":[{"name":"pagesize","type":"integer","format":"int64","defaultValue":500,"description":"max amount of entries per query","in":"query","required":false},{"name":"page","type":"integer","format":"int64","description":"page","in":"query","required":false}],"summary":"Get all bounces for your account. \ud83d\udd10","description":" returns a list with all bounces for your account

                  We categorize bounces according to the messages from the receiving mailserver:

                  Categories (exerpt):
                  - permanent\/hardbounce<\/code>: mailbox does not exist
                  - softbounce<\/code>: temporary errors
                  - blocked<\/code>: receiving mailserver didn't accept our email
                  - delayed<\/code>: temporary delivery error
                  - spam<\/code>: receiving mailserver categorized your email as spam

                  There are also two types of bounces:
                  - type: mailing<\/code> -- bounce was created through a mailing
                  - type: doi<\/code> -- bounce was created while sending the DOI emails (form signup)
                  type_id<\/code> is either the mailing id or the form id depending on the type

                  Example response data:<\/strong>
                  {
                    \"email\": \"batman@gotham.com\",
                    \"category\": \"hardbounce\",
                    \"occurences\": 1,
                    \"last_update\": 1595229122,
                    \"last_update_gmt\": \"2020-07-20T07:12:02+00:00\",
                    \"expires_by\": 1626855819,
                    \"expires_by_gmt\": \"2021-07-21T08:23:39+00:00\",
                    \"bounce_message\": \"smtp; 550 Recipient does not exist\",
                    \"type\": \"doi\",
                    \"type_id\": \"12345678\"
                  },
                  <\/code>

                  The pagesize is limited to 500. To get more, retrieve another page.<\/strong>
                  ","responses":{"200":{"description":"Success","schema":{"type":"array","items":{"type":"string"}}}},"security":[{"api_key":[]}]}}},"definitions":{"clientClientTagsSaveModel":{"properties":{"tags":{"type":"string","description":"(comma-separated list of) tags"}},"required":["tags"]},"clientSetPaymentSourceModel":{"properties":{"source":{"type":"string","description":"myself, agency, agency_invoice"}},"required":["source"]},"clientSetPaymentOptionsModel":{"properties":{"options":{"type":"integer","format":"int64","description":"100: prepaid, 250: free flatrate"}},"required":["options"]},"clientCreateWhitelabelClientModel":{"properties":{"email":{"type":"string","description":"email adress"},"salutation":{"type":"string","description":"salutation"},"firstname":{"type":"string","description":"first name"},"name":{"type":"string","description":"last name"},"company":{"type":"string","description":"company"},"street":{"type":"string","description":"street"},"zip":{"type":"string","description":"zip"},"city":{"type":"string","description":"city"},"phone":{"type":"string","description":"phone"},"country":{"type":"string","description":"country - leave empty to chose your country"},"send_login":{"type":"boolean","description":"send login data to new user (default: false)"},"user":{"type":"object","description":"user object with email, login, password"},"settings":{"type":"object","description":"settings object for several configurations"}},"required":["email","salutation","firstname","name","company","street","zip","city","phone"]},"createblacklistModel":{"properties":{"email":{"type":"string","description":"email"},"comment":{"type":"string","description":"Comment"}},"required":["email"]},"updateblacklistModel":{"properties":{"email":{"type":"string","description":"email"},"comment":{"type":"string","description":"Comment"}},"required":["email"]},"blacklistBatchModel":{"properties":{"items":{"type":"array","items":{"type":"string"},"description":"comment?: string}> $items Blacklist entries"}},"required":["items"]},"blacklistGroupBlacklistAddModel":{"properties":{"email":{"type":"string","description":"Email to blocklist"}},"required":["email"]},"blacklistFilterEmailListModel":{"properties":{"emails":{"type":"array","items":{"type":"string"},"description":"list of emails - max 1000 entries"},"group_id":{"type":"string","description":"GroupID - leave empty for global results"},"invert":{"type":"boolean","description":"inverts result and returns only invalid adresses"}},"required":["emails"]},"creategroupModel":{"properties":{"name":{"type":"string","description":"Group Name"},"receiver_info":{"type":"string","description":"Notes about the receivers in this list"},"locked":{"type":"boolean","description":"lock group from deleting (default: false)"},"backup":{"type":"boolean","description":"backup group (default: true)","defaultValue":true}},"required":["name"]},"updategroupModel":{"properties":{"name":{"type":"string","description":"Group Name"},"receiver_info":{"type":"string","description":"Notes about the receivers in this list"},"locked":{"type":"boolean","description":"lock group from deleting (default: false)"},"backup":{"type":"boolean","description":"backup group (default: true)"}}},"formCreateTemplateFormModel":{"properties":{"extradata":{"type":"object","description":"exclusive values for chosen template (see example post data)"}},"required":["extradata"]},"formSendMailModel":{"properties":{"email":{"type":"string","description":"receiver email"},"doidata":{"type":"object","description":"doidata, please see example"}},"required":["email","doidata"]},"createattributeModel":{"properties":{"name":{"type":"string","description":"name for internal use"},"type":{"type":"string","description":"type of data (text|number|gender|date)","enum":["text","number","gender","date"]},"group_id":{"type":"string","description":"ID of group - leave empty for global attributes"},"description":{"type":"string","description":"description"},"preview_value":{"type":"string","description":"preview value"},"default_value":{"type":"string","description":"default value"}},"required":["name","type"]},"attributeUpdate_attrModel":{"properties":{"type":{"type":"string","description":"Type of data (text|number|gender|date)","enum":["text","number","gender","date"]},"description":{"type":"string","description":"description"},"preview_value":{"type":"string","description":"preview value"},"group_id":{"type":"string","description":"group id"}}},"attributeCreate_groupsModel":{"properties":{"name":{"type":"string","description":"name for internal use"},"type":{"type":"string","description":"Type of data (text|number|gender|date)","enum":["text","number","gender","date"]},"description":{"type":"string","description":"description"},"preview_value":{"type":"string","description":"preview value"},"default_value":{"type":"string","description":"default value"}},"required":["name","type"]},"attributeUpdate_grpsModel":{"properties":{"type":{"type":"string","description":"Type of data (text|number|gender|date)","enum":["text","number","gender","date"]},"description":{"type":"string","description":"description"},"preview_value":{"type":"string","description":"preview value"}}},"attributeSavePoolAttribute_groupsModel":{"properties":{"value":{"type":"string","description":"Value"}},"required":["value"]},"attributeSavePoolAttribute_receiversModel":{"properties":{"value":{"type":"string","description":"Value"}},"required":["value"]},"filterCreateFilterModel":{"properties":{"name":{"type":"string","description":"active only"},"rules":{"type":"array","items":{"type":"string"},"description":"Array of rules"},"operator":{"type":"string","description":"default operator to use","defaultValue":"AND"}},"required":["name","rules"]},"filterUpdateFilterModel":{"properties":{"name":{"type":"string","description":"active only"},"rules":{"type":"array","items":{"type":"string"},"description":"Array of rules"},"operator":{"type":"string","description":"default operator to use","defaultValue":"AND","enum":["AND","OR"]}}},"filterRuntimeModel":{"properties":{"rules":{"type":"array","items":{"type":"string"},"description":"Array of rules"},"groups":{"type":"array","items":{"type":"string"},"description":"Array of group IDs"},"operator":{"type":"string","description":"the default operator to be used (default: AND)","defaultValue":"AND"},"orderby":{"type":"string","description":"Order by given Field f.e. \"registered DESC\". only 1 possible"},"detail":{"type":"integer","format":"int64","description":"Detail depth (bitwise combinable) (0: none, 1: events, 2: orders, 4: tags)"},"pagesize":{"type":"integer","format":"int64","description":"Pagesize (default: 250)","defaultValue":250},"page":{"type":"integer","format":"int64","description":"Page (default: 0)"}},"required":["rules","groups"]},"filterRuntimeFilterModel":{"properties":{"rules":{"type":"array","items":{"type":"string"},"description":"Array of rules"},"groups":{"type":"array","items":{"type":"string"},"description":"Array of groups - leave empty for all available groups"},"operator":{"type":"string","description":"Default operator to combine rules (default: AND)","defaultValue":"AND"},"orderby":{"type":"string","description":"Order by given Field f.e. \"registered DESC\". only 1 possible"},"detail":{"type":"integer","format":"int64","description":"Detail depth (bitwise combinable) (0: none, 1: events, 2: orders, 4: tags)"},"pagesize":{"type":"integer","format":"int64","description":"Pagesize (default: 50)","defaultValue":50},"page":{"type":"integer","format":"int64","description":"Page (default: 0)"},"activeonly":{"type":"boolean","description":"ActiveOnly (default: false) if true, it will only return active subscribers"},"last_poolid":{"type":"string","description":"returns only receivers where the ID is higher then this one. (default: \"\")"},"inactive_events":{"type":"boolean","description":""},"super_tags":{"type":"string","description":""},"fast_mode":{"type":"string","description":""},"debug":{"type":"string","description":""}},"required":["rules"]},"filterEmailListModel":{"properties":{"list":{"type":"array","items":{"type":"string"},"description":"Array of emails"},"groups_id":{"type":"string","description":"group ID"},"detail":{"type":"integer","format":"int64","description":"Detail depth (bitwise combinable) (0: none, 1: events, 2: orders, 4: tags)"}},"required":["list"]},"createreceiverModel":{"properties":{"postdata":{"type":"object","description":"Data for receivers to be inserted"}},"required":["postdata"]},"receiverList_groupsModel":{"properties":{"pagesize":{"type":"integer","format":"int64","description":"Pagesize (max 5000)","defaultValue":50},"page":{"type":"integer","format":"int64","description":"Page (zero-based)"},"type":{"type":"string","description":"Type","defaultValue":"all","enum":["all","active","inactive","bounce"]},"detail":{"type":"integer","format":"int64","description":"Detail depth (bitwise combinable) (0: none, 1: events, 2: orders, 4: tags)"},"email_list":{"type":"string","description":"list of receiver emails to filter for. Comma separated like: \"foo@bar.com,bar@foo.com,...\""},"id_list":{"type":"string","description":"list of Receiver ID's to filter for. comma separated like: \"123,633,5342\""},"order_by":{"type":"string","description":"field to order by, append 'asc' or 'desc' with a space"}}},"updatereceiverModel":{"properties":{"postdata":{"type":"object","description":"Receiver data to be updated"}},"required":["postdata"]},"receiverAddTagsModel":{"properties":{"tags":{"type":"array","items":{"type":"string"},"description":"tags to be added"},"group_id":{"type":"string","description":"(optional) ID of the group"}},"required":["tags"]},"receiverUpsertModel":{"properties":{"postdata":{"type":"array","items":{"type":"string"},"description":"Please see example"}},"required":["postdata"]},"receiverUpdateModel":{"properties":{"postdata":{"type":"array","items":{"type":"string"},"description":"Please see example"}},"required":["postdata"]},"receiverUpdateplusModel":{"properties":{"postdata":{"type":"array","items":{"type":"string"},"description":"Please see example"}},"required":["postdata"]},"receiverUpsertplusModel":{"properties":{"postdata":{"type":"array","items":{"type":"string"},"description":"Data"}},"required":["postdata"]},"receiverInsertModel":{"properties":{"postdata":{"type":"array","items":{"type":"string"},"description":"Data for receivers to be inserted"}},"required":["postdata"]},"receiverCloneReceiverModel":{"properties":{"email":{"type":"string","description":"the new email"},"target_group_id":{"type":"string","description":"ID of group the cloned receiver will be assigned to"},"overwrite":{"type":"boolean","description":"if receiver with email exists, overwrite"}},"required":["email","target_group_id"]},"receiverChangeEmailModel":{"properties":{"email":{"type":"string","description":"the new email"},"overwrite":{"type":"boolean","description":"if receiver with email exists, overwrite"}},"required":["email"]},"receiverRemoveMultiple_groupModel":{"properties":{"receivers":{"type":"array","items":{"type":"string"},"description":"Receiver IDs or emails"}},"required":["receivers"]},"receiverRemoveMultipleModel":{"properties":{"receivers":{"type":"array","items":{"type":"string"},"description":"Receiver IDs or emails"},"group_id":{"type":"string","description":"Group ID (default 0)"}},"required":["receivers"]},"receiverIsvalidModel":{"properties":{"emails":{"type":"array","items":{"type":"string"},"description":"list of emails - max 1000 entries"},"group_id":{"type":"string","description":"GroupID - leave empty for global results"},"invert":{"type":"boolean","description":"inverts result and returns only invalid adresses"}},"required":["emails"]},"createmycontentModel":{"properties":{"name":{"type":"string","description":"Name"},"url":{"type":"string","description":"URL"},"password":{"type":"string","description":"(optional) password"},"type":{"type":"string","description":"(optional) type of content (default,product,content)","enum":["none","default","product","content","blog"]},"cors":{"type":"boolean","description":"(optional) cross origin ability flag"},"icon":{"type":"string","description":"(optional) name of a certain icon"}},"required":["name","url"]},"updatemycontentModel":{"properties":{"name":{"type":"string","description":"(optional) Name"},"url":{"type":"string","description":"(optional) URL"},"password":{"type":"string","description":"(optional) password"},"type":{"type":"string","description":"(optional) type of content (default,product,content)","enum":["none","default","product","content","blog"]},"cors":{"type":"boolean","description":"(optional) cross origin ability flag"},"icon":{"type":"string","description":"(optional) name of a certain icon"}}},"eventReceivers_createModel":{"properties":{"value":{"type":"string","description":"Log Data \/ Text"},"group_id":{"type":"string","description":"ID of the group"},"type":{"type":"string","description":"type of log (default: log)","defaultValue":"log"},"type_id":{"type":"string","description":"typeID (internal usage only)"},"mailing_id":{"type":"string","description":"MailingID (mostly internal usage)"}},"required":["value"]},"event":{"properties":{"filter":{"type":"array","items":{"type":"string"},"description":""}},"required":["filter"]},"createeventModel":{"properties":{"value":{"type":"string","description":"Log Data \/ Text"},"type":{"type":"string","description":"typeID (internal usage only)","defaultValue":"log"},"type_id":{"type":"string","description":"MailingID (mostly internal usage)"},"mailing_id":{"type":"string","description":""}},"required":["value"]},"eventSetMailSentModel":{"properties":{"receiver_id_list":{"type":"string","description":"array of receiver IDs"},"mailing_type":{"type":"string","description":"Type of Mailing (see \\mailing -> type_name)"}},"required":["receiver_id_list"]},"orderCreate_groupModel":{"properties":{"order_id":{"type":"string","description":"order ID"},"product":{"type":"string","description":"Product Name"},"product_id":{"type":"string","description":"your productID (default:null)"},"stamp":{"type":"integer","format":"int64","description":"date of order (default:current time)"},"price":{"type":"number","format":"double","description":"product price (single) (default:0)"},"quantity":{"type":"integer","format":"int64","description":"quantity bought (default:1)","defaultValue":1},"mailing_id":{"type":"string","description":"mailingID, if bought through mailing (conversion tracking) (default:null)"},"source":{"type":"string","description":"shopname or sourcename"},"currency":{"type":"string","description":"currency used (default:EUR)","defaultValue":"EUR"}},"required":["order_id","product"]},"order":{"properties":{"filter":{"type":"array","items":{"type":"string"},"description":""}},"required":["filter"]},"createorderModel":{"properties":{"order_id":{"type":"string","description":"order ID"},"product":{"type":"string","description":"Product Name"},"group_id":{"type":"string","description":"Group ID (optional)"},"product_id":{"type":"string","description":"your productID (default:null)"},"stamp":{"type":"integer","format":"int64","description":"date of order (default:current time)"},"price":{"type":"number","format":"double","description":"product price (single) (default:0)"},"quantity":{"type":"integer","format":"int64","description":"quantity bought (default:1)","defaultValue":1},"mailing_id":{"type":"string","description":"mailingID, if bought through mailing (conversion tracking) (default:null)"},"source":{"type":"string","description":"shopname or sourcename"},"currency":{"type":"string","description":"currency used (default:EUR)","defaultValue":"EUR"}},"required":["order_id","product"]},"orderUpdate_groupsModel":{"properties":{"product":{"type":"string","description":"Product Name"},"product_id":{"type":"string","description":"your productID (default:null)"},"stamp":{"type":"integer","format":"int64","description":"date of order (default:current time)"},"price":{"type":"number","format":"double","description":"product price (single) (default:0)"},"quantity":{"type":"integer","format":"int64","description":"quantity bought (default:1)","defaultValue":1},"mailing_id":{"type":"string","description":"mailingID, if bought through mailing (conversion tracking) (default:null)"},"source":{"type":"string","description":"shopname or sourcename"},"currency":{"type":"string","description":"currency used (default:EUR)","defaultValue":"EUR"}},"required":["product"]},"updateorderModel":{"properties":{"product":{"type":"string","description":"Product Name"},"product_id":{"type":"string","description":"your productID (default:null)"},"group_id":{"type":"string","description":"Group ID"},"stamp":{"type":"integer","format":"int64","description":"date of order (default:current time)"},"price":{"type":"number","format":"double","description":"product price (single) (default:0)"},"quantity":{"type":"integer","format":"int64","description":"quantity bought (default:1)","defaultValue":1},"mailing_id":{"type":"string","description":"mailingID, if bought through mailing (conversion tracking) (default:null)"},"source":{"type":"string","description":"shopname or sourcename"},"currency":{"type":"string","description":"currency used (default:EUR)","defaultValue":"EUR"}},"required":["product"]},"createmailingModel":{"properties":{"name":{"type":"string","description":"internal name of the mailing"},"subject":{"type":"string","description":"subject of the mail"},"sender_name":{"type":"string","description":"name of the sender"},"sender_email":{"type":"string","description":"sender email"},"content":{"type":"object","description":"definition object for mail content (see example)"},"receivers":{"type":"object","description":"definition object for receivers (see example)"},"settings":{"type":"object","description":"definition object for settings (see example)"},"tags":{"type":"array","items":{"type":"string"},"description":"tags for the mail"}},"required":["name","subject","sender_name","sender_email"]},"updatemailingModel":{"properties":{"name":{"type":"string","description":"internal name of the mailing"},"subject":{"type":"string","description":"subject of the mail"},"sender_name":{"type":"string","description":"name of the sender"},"sender_email":{"type":"string","description":"sender email"},"content":{"type":"object","description":"definition object for mail content (see example)"},"receivers":{"type":"object","description":"definition object for receivers (see example)"},"settings":{"type":"object","description":"definition object for settings (see example)"},"tags":{"type":"array","items":{"type":"string"},"description":"tags for the mail"}}},"mailingAddreceiversModel":{"properties":{"receivers":{"type":"array","items":{"type":"string"},"description":""},"skipBlacklistCheck":{"type":"boolean","description":"disable blacklist check which might be unecassary for internal calls"},"skipCheckContingent":{"type":"boolean","description":"disable contigent check which might be unecassary for internal calls"},"packetIndex":{"type":"integer","format":"int64","description":""},"templatedata":{"type":"object","description":""},"bulkqueue":{"type":"string","description":""}}},"mailingSendPreviewModel":{"properties":{"receivers":{"type":"array","items":{"type":"string"},"description":"emails of receivers"},"previewText":{"type":"string","description":"text to be added to the subject"}},"required":["receivers"]},"mailingAdd2positionModel":{"properties":{"amount":{"type":"integer","format":"int64","description":""}}},"mailingSetstatusModel":{"properties":{"status":{"type":"integer","format":"int64","description":"","defaultValue":5}}},"mailingStartMailingModel":{"properties":{"time":{"type":"integer","format":"int64","description":"Timestamp of start"}}},"mailingCreateTemplateModel":{"properties":{"name":{"type":"string","description":"internal name of the template"},"html":{"type":"string","description":"html code of the template"},"tags":{"type":"array","items":{"type":"string"},"description":"tags for the template"}},"required":["name","html"]},"reportDropoutModel":{"properties":{"group_id":{"type":"string","description":"group ID"},"pool_id":{"type":"string","description":"receiver ID"}},"required":["group_id","pool_id"]},"tagRetrieveReceiverCountComplexModel":{"properties":{"tags":{"type":"array","items":{"type":"string"},"description":"list of tags to get the counts for"},"group_id":{"type":"string","description":"group id to filter, leave blank (or choose 0) for all groups"}},"required":["tags"]},"oauthFinishModel":{"properties":{"finished":{"type":"boolean","description":"set to true, if the process is truely finished"},"name":{"type":"string","description":"name of the customer, mostly the first name"},"brand":{"type":"string","description":"name of the service that triggered the oauth"},"client_id":{"type":"string","description":"client_id of the oauth application (NOT the cleverreach client_id!)"},"config":{"type":"string","description":""}},"required":["finished","name","brand","client_id"]},"oauthSettingsModel":{"properties":{"import":{"type":"array","items":{"type":"string"},"description":"what the user chose to be imported during installation."},"not_import":{"type":"array","items":{"type":"string"},"description":"what the user chose to not be imported during installation."}}},"createautomationModel":{"properties":{"name":{"type":"string","description":"Name"},"storeid":{"type":"string","description":"ID from store"},"description":{"type":"string","description":"Description"},"source":{"type":"string","description":"The source of the AbandonedCarts","defaultValue":"unknown"}},"required":["name","storeid"]},"createtriggerModel":{"properties":{"poolid":{"type":"string","description":"Receiver PoolID or Email"},"groupid":{"type":"string","description":"The Groupid of the receiver"},"abandonedCartData":{"type":"array","items":{"type":"string"},"description":"The data itself in json format. Example below"}},"required":["poolid"]},"sSLCreateallModel":{"properties":{"cert":{"type":"string","description":"String with SSL Certificate in it `BEGIN CERTIFICATE ....`"},"key":{"type":"string","description":"String with SSL Private key in it `BEGIN PRIVATE KEY ....`"}},"required":["cert","key"]},"createSSLModel":{"properties":{"cert":{"type":"string","description":"String with SSL Certificate in it `BEGIN CERTIFICATE ....`"},"key":{"type":"string","description":"String with SSL Private key in it `BEGIN PRIVATE KEY ....`"}},"required":["cert","key"]},"createSysMailModel":{"properties":{"mailtemplate":{"type":"string","description":"name of the template"},"receivers":{"type":"string","description":"RECEIVER LSIT"},"data":{"type":"string","description":"EXTRA TEMPLATEDATA"},"loop":{"type":"string","description":"EXTRA loopTEMPLATEDATA"}},"required":["mailtemplate","receivers"]},"telemetryIntegration_eventsModel":{"properties":{"v":{"type":"integer","format":"int64","description":"Schema version"},"event":{"type":"string","description":"Event type"},"event_id":{"type":"string","description":"Unique event ID"},"ts":{"type":"string","description":"UTC timestamp"},"customer_id":{"type":"string","description":"Customer identifier"},"integration_id":{"type":"string","description":"Integration type"},"integration_version":{"type":"string","description":"Integration version"},"environment":{"type":"string","description":"Environment"},"source":{"type":"string","description":"Event source"},"details":{"type":"array","items":{"type":"string"},"description":"Additional details"}},"required":["v","event","event_id","ts","customer_id","integration_id","integration_version","environment","source","details"]},"mail_server":{"properties":{"id":{"type":"string","description":""},"name":{"type":"string","description":""},"mailserver_group_id":{"type":"string","description":""},"ip":{"type":"string","description":""},"port":{"type":"string","description":""},"sender":{"type":"string","description":""},"login":{"type":"string","description":""},"password":{"type":"string","description":""},"used":{"type":"string","description":""},"max_mailings":{"type":"string","description":""},"premium":{"type":"string","description":""},"queue":{"type":"string","description":""},"transport_id":{"type":"string","description":""},"count":{"type":"string","description":""},"pause":{"type":"string","description":""},"error_stamp":{"type":"string","description":""}},"required":["id","name","mailserver_group_id","ip","port","sender","login","password","used","max_mailings","premium","queue","transport_id","count","pause","error_stamp"]},"mailserversStopByIPModel":{"properties":{"ip":{"type":"string","description":"Mailserver IP Address or Hostname"}},"required":["ip"]},"mailserversStartByIPModel":{"properties":{"ip":{"type":"string","description":"Mailserver IP Address or Hostname"}},"required":["ip"]},"createAccountingModel":{"properties":{"type":{"type":"string","description":"type on item (email, flatrate, tests, etc)","defaultValue":"email"},"amount":{"type":"integer","format":"int64","description":"amount added\/subsctraced"},"expires":{"type":"integer","format":"int64","description":"expiredate (use with caution)"},"status":{"type":"integer","format":"int64","description":"0\/1 for active or not","defaultValue":1},"processed":{"type":"integer","format":"int64","description":"0 or 1, never 2, all other will be written but ignored","defaultValue":1},"object":{"type":"string","description":"object name if applicable"},"object_id":{"type":"string","description":"object ID if available"},"data":{"type":"array","items":{"type":"string"},"description":"extra data if necessary"}}},"updateAccountingModel":{"properties":{"type":{"type":"string","description":"type on item to find (email, flatrate, tests, etc)"},"amount":{"type":"integer","format":"int64","description":"amount added\/subsctraced"},"expires":{"type":"integer","format":"int64","description":"expiredate (use with caution)"},"status":{"type":"integer","format":"int64","description":"0\/1 for active or not","defaultValue":1},"processed":{"type":"integer","format":"int64","description":"0 or 1, never 2, all other will be written but ignored","defaultValue":1},"object":{"type":"string","description":"object name if applicable"},"object_id":{"type":"string","description":"object ID if available"},"data":{"type":"array","items":{"type":"string"},"description":"extra data if necessary"}},"required":["type"]},"accountingCancelExpiresModel":{"properties":{"type":{"type":"string","description":"type on item (email, flatrate, tests, etc)","defaultValue":"email"},"time":{"type":"integer","format":"int64","description":"closing time as timestamp (default: time of request)"},"force_zero":{"type":"boolean","description":"also compensate minus contingents (default: false)"}}},"accountingRemoveMailContingentModel":{"properties":{"amount":{"type":"integer","format":"int64","description":"amount added\/subsctraced"}},"required":["amount"]},"accountingTestContingentModel":{"properties":{"amount":{"type":"integer","format":"int64","description":"(default 0)Amount of emails"},"type":{"type":"string","description":"(default \"email\") Type of contingent. so far, only \"email\" is available","defaultValue":"email"}}},"createApprovalModel":{"properties":{"client_id":{"type":"integer","format":"int64","description":"Client ID"},"group_id":{"type":"integer","format":"int64","description":"Group ID"}},"required":["client_id","group_id"]},"approvalAddCommentModel":{"properties":{"message":{"type":"string","description":"Message"}},"required":["message"]},"approvalQuestionModel":{"properties":{"question":{"type":"string","description":"Question"}},"required":["question"]},"approvalDeclineModel":{"properties":{"reason":{"type":"string","description":"Reason for declining the approval"},"renew":{"type":"boolean","description":"Allow a new approval"}},"required":["reason"]},"approvalAllowModel":{"properties":{"reason":{"type":"string","description":"Reason for allowing the approval"},"permanent":{"type":"boolean","description":"Permanent approval?"}},"required":["reason"]},"approvalSetStatusModel":{"properties":{"newStatus":{"type":"integer","format":"int64","description":"new Status"}},"required":["newStatus"]},"convertSerializedToJSONModel":{"properties":{"serialized":{"type":"string","description":"serialized string to decode"}},"required":["serialized"]},"accountingSetActiveModel":{"properties":{"value":{"type":"integer","format":"int64","description":"Status value"}},"required":["value"]},"mailingsAddBounceModel":{"properties":{"client_id":{"type":"integer","format":"int64","description":"Client ID"},"email":{"type":"string","description":"Email address"},"expires":{"type":"integer","format":"int64","description":"Expiration time"},"category":{"type":"string","description":"Category","defaultValue":"unknown"},"subcategory":{"type":"string","description":"Subcategory","defaultValue":"unknown"},"detail":{"type":"string","description":"Detail","defaultValue":"none"}},"required":["client_id","email"]},"blacklistEcgListedModel":{"properties":{"email":{"type":"string","description":"Email Address to check for"}},"required":["email"]},"blacklistEcgAddModel":{"properties":{"email":{"type":"string","description":"Email Address to add"}},"required":["email"]},"scanCheckFromModel":{"properties":{"from":{"type":"string","description":"String to check"},"clientID":{"type":"string","description":""}},"required":["from","clientID"]},"scanCheckSubjectModel":{"properties":{"subject":{"type":"string","description":""},"clientID":{"type":"string","description":""}},"required":["subject","clientID"]},"scanCheckBodyModel":{"properties":{"body":{"type":"string","description":""},"clientID":{"type":"string","description":""}},"required":["body","clientID"]}},"securityDefinitions":{"api_key":{"type":"apiKey","in":"header","name":"Authorization","description":"Bearer token"}},"info":{"version":"3","title":"CleverReach REST API","description":"CleverReach REST API documentation. This API is used to access CleverReach resources and perform actions on them.

                  See https:\/\/developers.cleverreach.com\/<\/a> for more information and documentation.","contact":{"name":"CleverReach","email":"support@cleverreach.com","url":"https:\/\/www.cleverreach.com\/"},"license":{"name":"","url":""}}}