Add Users via API

Using the platform's APIs, target users may be effortlessly migrated. The API endpoints that are required are detailed below.

Use your own domain if you are using an on-premise version. e.g. https://api.PLATFORM_DOMAIN/docs/index.html

Instructions for adding target users using an API

POST ​/api​/target-users

• Go to the Swagger link.

• Click the Authorize button on the top right side of the page.

• Complete the authorization step with the Client ID and Client Secret key that you created on the platform.

• Make sure that the api1 option is checked (✓) on the Scopes section.

• Then use this endpoint to add a new target user to the platform.

The most up-to-date format of the body content that you need to use for requesting an API is available on the Swagger interface.

Searching for a user using API

POST ​/api​/target-users​/search

• Go to the Swagger link.

• Click the Authorize button on the top right side of the page.

• Complete the authorization step with the Client ID and Client Secret key that you created on the platform.

• Make sure that the api1 option is checked (✓) on the Scopes section.

• Then use this endpoint to search for a target user on the platform.

The most up-to-date format of the body content that you need to use for requesting an API is available on the Swagger interface.

Editing Target Users using API

PUT ​/api​/target-users​/{resourceId}

• Go to the Swagger link.

• Click the Authorize button on the top right side of the page.

• Complete the authorization step with the Client ID and Client Secret key that you created on the platform.

• Make sure that the api1 option is checked (✓) on the Scopes section.

• Then use this endpoint to edit a target user on the platform.

The most up-to-date format of the body content that you need to use for requesting an API is available on the Swagger interface.

​✅ You have now added your first Target Users. Now you need to ensure they are able to receive emails from Keepnet successfully ➡️

Video Tutorial