Perfiles

Un perfil es una marca o un cliente final. Las cuentas sociales se conectan a un perfil.

Listar perfiles

GET/v1/profiles

Respuesta 200

data []

idstringobligatorio
namestringobligatorio
timezonestring
externalIdstring
createdAtstring (date-time)obligatorio
updatedAtstring (date-time)obligatorio

curl "https://api.usecrier.com/v1/profiles" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/profiles', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/profiles",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Crear un perfil

POST/v1/profiles

Cuerpo

namestringobligatorio
Nombre de la marca o del cliente final.
máx. 100
timezonestring
Zona horaria IANA, por ejemplo Europe/Madrid. La usa la cola.
máx. 64
externalIdstring
Tu propio id para este cliente; se devuelve tal cual.
máx. 200

Respuesta 201

data

idstringobligatorio
namestringobligatorio
timezonestring
externalIdstring
createdAtstring (date-time)obligatorio
updatedAtstring (date-time)obligatorio

curl -X POST "https://api.usecrier.com/v1/profiles" \
  -H "Authorization: Bearer $CRIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme",
    "timezone": "Europe/Madrid",
    "externalId": "customer-42"
  }'

const res = await fetch('https://api.usecrier.com/v1/profiles', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Acme",
    "timezone": "Europe/Madrid",
    "externalId": "customer-42"
  }),
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/profiles",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
    json={
        "name": "Acme",
        "timezone": "Europe/Madrid",
        "externalId": "customer-42"
    },
)
data = res.json()["data"]

Ver un perfil

GET/v1/profiles/{id}

Parámetros

idstringobligatorio

Respuesta 200

data

idstringobligatorio
namestringobligatorio
timezonestring
externalIdstring
createdAtstring (date-time)obligatorio
updatedAtstring (date-time)obligatorio

curl "https://api.usecrier.com/v1/profiles/prf_8f2k4d" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/profiles/prf_8f2k4d', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/profiles/prf_8f2k4d",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Editar un perfil

PATCH/v1/profiles/{id}

Parámetros

idstringobligatorio

Cuerpo

namestring
Nombre de la marca o del cliente final.
máx. 100
timezonestring
Zona horaria IANA, por ejemplo Europe/Madrid. La usa la cola.
máx. 64
externalIdstring
Tu propio id para este cliente; se devuelve tal cual.
máx. 200

Respuesta 200

data

idstringobligatorio
namestringobligatorio
timezonestring
externalIdstring
createdAtstring (date-time)obligatorio
updatedAtstring (date-time)obligatorio

curl -X PATCH "https://api.usecrier.com/v1/profiles/prf_8f2k4d" \
  -H "Authorization: Bearer $CRIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Spain"
  }'

const res = await fetch('https://api.usecrier.com/v1/profiles/prf_8f2k4d', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Acme Spain"
  }),
});
const { data } = await res.json();

import os, requests

res = requests.patch(
    "https://api.usecrier.com/v1/profiles/prf_8f2k4d",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
    json={
        "name": "Acme Spain"
    },
)
data = res.json()["data"]

Borrar un perfil

DELETE/v1/profiles/{id}

También desconecta sus cuentas.

Parámetros

idstringobligatorio

Respuesta 204

Sin contenido

curl -X DELETE "https://api.usecrier.com/v1/profiles/prf_8f2k4d" \
  -H "Authorization: Bearer $CRIER_API_KEY"

await fetch('https://api.usecrier.com/v1/profiles/prf_8f2k4d', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});

import os, requests

requests.delete(
    "https://api.usecrier.com/v1/profiles/prf_8f2k4d",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)