1. Log in to your Omnisend account

If you don’t have an account, create one on Omnisend website.

2. Create API Key

Navigate to the Api Keys section of your Omnisend account.

Click Create API key and give it a descriptive name that will remind you which application it’s used for.
Copy the generated key immediately and store it in a secure location. You won’t be able to see or copy the key once you finish generating it.

Read more about API Keys in our knowledge base.

3. Sending First API Request

Now that you have the API key you can try creating your first contact via API.

In the code below replace YOUR-API-KEY with your actual key.

It will create a contact that is subscribed via hello@example.com email.

You can run the code below in your computer terminal, import it Postman or simply use interactive builder.

curl --request POST \
     --url https://api.omnisend.com/v3/contacts \
     --header 'X-API-KEY: YOUR-API-KEY' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "identifiers": [
    {
      "type": "email",
      "channels": {
        "email": {
          "status": "subscribed",
          "statusDate": "2023-01-01T10:07:28Z"
        }
      },
      "id": "hello@example.com"
    }
  ]
}
'

Next Actions

Now you can start creating integration to:

Sync or Get Omnisend Contacts
Send Events to trigger automation.
Send carts & orders to create a custom abandoned cart workflow.
Trigger campaigns programmatically.
and more.

For this and more functionality check API reference in the sidebar.

Need help?

Don't be afraid to contact us. We are always ready to help!