How do I create a new Profile via Klaviyo's REST API?

Question

Hello!I’ve been trying to set up some custom integrations via Klaviyo’s REST API and I seem to have reached a wall. I’m trying to create new Profiles based on data from our back-end. I’ve come across two difficulties:I seem to be unable to POST a new profile. Whenever I try via the server responds with “Method "POST" not allowed.” Then, whenever I try to create a new Profile via a PUT request it says “'The requested resource does not exist.' Is it possible to create a new Profile and not just modify an existing one?	If the above is possible, are you able to create a new Profile without assigning an ID an let Klaviyo generate one for you? Any help would be greatly appreciated, thanks!

remstone · Accepted Answer

Hey @jnazemi! You could do this in a couple ways but it really depends on how you’re creating the profile.

Here are the couple options:

If you want to create a profile and add a user to a list, you can use the following endpoint: https://www.klaviyo.com/docs/api/v2/lists#post-subscribe (note, this follows the opt-in settings for the list)
If you want to just add a profile or add a profile and add custom properties, I’d recommend this endpoint: https://www.klaviyo.com/docs/http-api#identify
If you want to add a profile and track an event as well as add custom properties, you can use this endpoint: https://www.klaviyo.com/docs/http-api#track

Note: option 2 and 3 have a slightly different authentication system than using the rest API like option 1.

Let me know if you have questions but here are some options!

Best,

Rem

jbutler · Answer

The profiles API needs a person ID to work, use the ‘identify’ API with the properties you want and that will create a profile. If you need to get the person ID you can use the call below. Its not part of the API docs but I was given this by their solutions architect.

curl -X GET \
  https://a.klaviyo.com/api/v2/people/search \
  -H 'Accept: */*' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'accept-encoding: gzip, deflate' \
  -H 'api-key: 'YOUR_PRIVATE_KEY' \
  -d '{"email":"CUSTOMER_EMAIL"}'

How do I create a new Profile via Klaviyo's REST API?

4 replies

Reply

Most helpful members this week

Reply

Most helpful members this week

Sign up

Use your Klaviyo credentials

Log in to the Community

Use your Klaviyo credentials

Scanning file for viruses.

This file cannot be downloaded