Create and edit API credentials

Use REST API credentials to integrate Inxmail into your IT environment and exchange data via the API.

Inxmail standard roles: We recommend that you use the Inxmail standard role "API credentials". This allows you to create and edit API credentials for all your spaces.

Custom roles: Alternatively, you can assign the following permission bundles within your custom roles:

(Depending on which types of spaces you are using, you may only see one or two of these permission bundles.)

Advanced REST API: If you have purchased the advanced REST API as an add-on, the permission bundle "Use the advanced API for Newsletters & campaigns " will also be available.

Get in touch with your rights manager if you are missing any permissions.

Info for existing customers: Your existing API credentials (e.g. from Inxmail Professional) will of course continue to work.

Step by step

  1. Open the "API credentials" navigation item.

  2. Click Create new API credentials or click the Edit icon for an API credential.

  3. Enter a meaningful name and description.

    Example: Use the connected system’s name or the intended purpose of this integration.

  4. Click “Select a role”.

    Permissions: Depending on the rights included in your roles, they apply at either space level or account level. Space-level permissions may apply in the Newsletters & campaigns and / or Transactional mails section. Find out more in the Inxmail standard roles description and at: What rights does a specific role contain?

  5. Click “Select a unit”.

  6. Select a unit and click Save.

  7. Choose a role for the selected unit.

    Inheritance: The role is automatically inherited and thus also applies to all subordinate units in your organizational chart.

  8. You can assign additional roles to the units below as needed.

  9. Click "Select a unit" once again and carry out the same steps for more units and roles for which you want to assign permissions.

  10. When you are done, click Save.

  11. Click Create.

  12. Copy your key and your secret to the clipboard to ensure they are available to you at a later time.

    Keep your secret safe: This is sensitive information. Do not disclose it or share it with others and save it in a secure location.

    Once you have completed this step, you will no longer have access to your secret: Make sure to store it in a safe location. Neither you nor Inxmail can access your secret once you close this dialog.

  13. Re-generate secret

    You can re-generate your secret if you have forgotten it or if it may have been compromised.

    In the overview table, click the "Re-generatesecret" icon and confirm. Alternatively, click the Edit icon, then Replace secret and confirm.

    Afterwards, copy your new secret to the clipboard and store it in all connected systems to ensure your integrations continue to run smoothly.

  14. Delete API credentials

    Delete API credentials by clicking the delete icon. Make sure you do not delete any active credentials. The "Last access" shows when the API credential was last used. If no date is displayed, it means it has never been used.

  • You have created or edited API credentials in Inxmail with key and secret.

Next step

  • Enter the API key and secret in your external system to exchange data with Inxmail via the API.

  • You can easily create additional API credentials – either by clicking the Duplicate icon in the overview table or by clicking Create again. In both cases, you will receive a new key and a new secret.