Cyberimpact

Make the specified member part of the specified groups.

Submit a batch for processing. Batches can be of three types: **addMembers**, **unsubscribe**, and **deleteMembers**. ### Batch type: unsubscribe Provide a list of member IDs (integer) or email addresses (string) to unsubscribe. ### Batch type: deleteMembers Provide a list of member IDs (integer) or email addresses (string) to delete. ### Batch type: addMembers Add or update members in bulk. Key behaviors: - If a member already exists, it is updated with the provided information. - If a field is empty and data already exists for that field, the existing data is kept. - To explicitly clear a field, use the special string `__EMPTY__`. - All submitted members will be added to the specified groups (in addition to any existing group memberships). - The `relationType` field is required and accepts: `express-consent`, `active-clients`, `information-request`, `business-card`, `web-contacts`, `purchased-list`, `contest-participants`, `mixed-list`, `inactive-clients`, `association-members`, `employees`, `partners`.

Add a new static group in your account.

Create a new mailing scheduled to be sent.

Add a new member in your account. If you need the member to confirm their subscription, it is recommended that you use the opt-in endpoint instead. If you use this method in an online form, it is **strongly recommended** to add a CAPTCHA to avoid abuse. Warning: This method is throttled. If you wish to use it for synchronization purposes between two systems, please contact us. If you need to add multiple members at once, use the batches endpoint.

Create a new template.

Delete a specific group based on its ID.

Delete a specific mailing based on its ID (only if it has not already been sent).

Delete a specific member based on their key.

Delete a specific template based on its ID.

Modify the representation of a group by changing only the specified attributes. Unspecified attributes are left untouched. Note: Editing a dynamic group is not possible from the API.

Modify the representation of a member by changing only the specified attributes. Unspecified attributes are left untouched.

Generate a token that will be associated to your account and be used to call this API.

Retrieve a paginated list of archived mailings.

Retrieve a specific batch based on its ID. This is useful to check whether a batch has finished processing and to get the results. Some requests in the batch may have succeeded while others failed. The `result` field provides the details.

Retrieve a paginated list of members for which a hard bounce was received for the last mailing sent to them.

List of custom fields set in your account. Field type can be one of: - text - date - integer - decimal number

Retrieve a specific group based on its ID.

Retrieve a paginated list of all the members in the specified group.

Retrieve a paginated list of groups.

Retrieve a specific mailing based on its ID.

Retrieve a paginated list of a mailing's recipients.

Retrieve a paginated list of a mailing's recipients which have clicked at least one link in the mailing.

Retrieve a paginated list of recipients to which the mailing was successfully delivered.

Retrieve a paginated list of a mailing's recipients which have hard bounced.

Retrieve a paginated list of a mailing's recipients which have opened the mailing.

Retrieve a paginated list of a mailing's recipients which have soft bounced.

Retrieve a paginated list of recipients for which the mailing was not sent because it was stopped. If the mailing was not stopped, this will return an empty list.

Retrieve a paginated list of a mailing's recipients which unsubscribed by using the unsubscribe link in the mailing.

Retrieve a specific member based on their key.

Retrieve more consent information for a specific member based on their key.

Retrieve a paginated list of the groups that the specified member is part of.

Retrieve a paginated list of the member's received mailings.

Retrieve a paginated list of your members. Active members are subscribed members that are part of group(s). Orphan members are subscribed members that are not part of a group. Note: The returned property `items_per_page` is deprecated and will eventually be removed. Use `limit` instead.

Simple function to verify your connection with the API.

Retrieve a paginated list of all scheduled mailings.

Retrieve a paginated list of all sent mailings. Note: This does not include any archived mailings.

Retrieve a specific template based on its ID.

Retrieve a paginated list of the templates.

Retrieve a specific unsubscribed member based on their email address.

Retrieve a paginated list of members who unsubscribed from your mailings.

Send an opt-in email to the specified email address, creating the member if not already existing and adding them to the specified list of groups. Warning: This method is throttled. If you use it in an online form, it is **strongly recommended** to add a CAPTCHA to avoid abuse.

Remove all members from a specific group.

Remove the specified member from the specified group.

Modify the representation of a group so that it becomes completely as specified. Unspecified attributes will be reset to their default empty values. Note: Replacing a dynamic group is not possible from the API.

Modify the representation of a member so that it becomes completely as specified. Unspecified attributes will be reset to their default empty values.

Replace completely the list of groups that a member is part of with the ones specified.

Modify the representation of a template so that it becomes completely as specified. Unspecified attributes will be reset to their default empty values.

Permanently revoke the API token identified by `tokenUniqueId`. Once revoked, the token can no longer be used to authenticate API requests.

Set consent for a specific member based on their key. Note: Some consent types cannot be overridden — this method returns a 422 status code with a message when that happens.

Unsubscribe a member based on their key. The field `isNewUnsubscription` indicates whether the unsubscription was new or the member was already unsubscribed.