Compat

Create or update a person (Customer.io)

PUT/v1/compat/customerio/api/v1/customers/{identifier}

Requires an API key with the contacts:write events:write scope. About keys and scopes

Customer.io's Track API v1, so an app sending to Customer.io can send here too while it moves, by pointing its client at …/v1/compat/customerio. Authenticate as Customer.io clients do, with HTTP Basic: any site id as the user and an Kirora API key as the password (a Bearer key works too). The identifier is the contact's externalId, or its email when it holds an @. first_name, last_name, email and phone fill those fields, unsubscribed: true withdraws email consent, and every other key becomes an attribute. Consent is never granted here: import it with its evidence. Agent keys are refused.

Requires API-key scope: contacts:write and events:write.

Path parameters

identifierstringrequired: 1–255 characters

Returns

Returns 200 OK. Otherwise returns an error; Errors lists every code and which to retry.

curl -X PUT https://api.kirora.io/v1/compat/customerio/api/v1/customers/identifier_example \
  -H "Authorization: Bearer $KIRORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch('https://api.kirora.io/v1/compat/customerio/api/v1/customers/identifier_example', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
const { data } = await response.json();

import os

import requests

response = requests.put(
    "https://api.kirora.io/v1/compat/customerio/api/v1/customers/identifier_example",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
    json={},
)
data = response.json()["data"]

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{}`)
	req, err := http.NewRequest("PUT", "https://api.kirora.io/v1/compat/customerio/api/v1/customers/identifier_example", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{}

Example values are generated from the schema.