Lookalike API

There are two ways to add domains to Lookalike detection

1. Bulk API: https://api.emailconsul.com/api/v1.0/doc/#/Lookalike/post_lookalike_add_bulk

2. Import CSV: https://api.emailconsul.com/api/v1.0/doc/#/Lookalike/post_lookalike_import

   CSV must contain a "domain" column.

All of these methods are upserting your domains, which means that if a domain is already added, it will not be added again, preventing duplication.

Right after a domain is added, EmailConsul starts searching for all potential lookalike domains. The first results will appear after a couple of minutes, if any exist.

To get a list of added domains, use the API https://api.emailconsul.com/api/v1.0/doc/#/Lookalike/get_lookalike.

To delete a bunch of domains, use the API https://api.emailconsul.com/api/v1.0/doc/#/Lookalike/delete_lookalike. With this API, you can delete domains that satisfy a filter from the passed parameters. Without parameters (filters), it removes all domains.

There are two ways to delete a domain:

1. By ID with https://api.emailconsul.com/api/v1.0/doc/#/Lookalike/delete_lookalike__id_

2. By using the Delete Domains API (https://api.emailconsul.com/api/v1.0/doc/#/Lookalike/delete_lookalike)

   To delete a specific domain, use the Delete Domains API with the filter by domain, like

   , where we send a request to delete example.com domain.

Use https://api.emailconsul.com/api/v1.0/doc/#/Lookalike/get_lookalike_available_count to see how many domains can be added within the current Usage Plan.

To get the list of found lookalikes related to a domain, use the API https://api.emailconsul.com/api/v1.0/doc/#/Lookalike/get_lookalike__id__lookalikes. Apply filters if needed.

To change a lookalike state , use the API https://api.emailconsul.com/api/v1.0/doc/#/Lookalike/post_lookalike__id__lookalikes__lookalike_id__change_state.

Available state options:

UNCLASSIFIED, THREAT, IGNORED