Saltar al contenido

Referencia de la API

Inicio de sesión y cuenta

8 operaciones, cada una con sus parámetros, ejemplos en curl y TypeScript listos para copiar y sus errores.

Cada ejemplo supone una sesión iniciada; cómo obtenerla está en Autenticación

signIn

POST/api/ins/sign

Sin sesiónPermiso: auth:anonymous

signIn

Parámetros de signIn
NombreDóndeTipoObligatorio
codeCuerpostring 0–64No
emailCuerpostring 1–320Sí
nextCuerpostring 0–2048No
passwordCuerpostring 1–1024Sí
curl
curl -X POST 'https://www.notificado.co/api/ins/sign' \
  -H 'content-type: application/json' \
  -d '{"email":"<email>","password":"<password>"}'
TypeScript
const response = await fetch('https://www.notificado.co/api/ins/sign', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    "email": "<email>",
    "password": "<password>"
  }),
});
const result = await response.json();
Ejemplo de respuesta
200
{
  "ok": true,
  "userId": "<userId>"
}

Errores

  • 400 X_INPUT_INVALID
  • 403 policy denied
  • 422 X_BODY_INVALID

unsubscribeOnboarding

POST/api/onboardings/unsubscribe

Miembro de la firmaPermiso: growth:unsubscribe-link

unsubscribeOnboarding

Parámetros de unsubscribeOnboarding
NombreDóndeTipoObligatorio
List-UnsubscribeCuerpostring 1–32No
tCuerpostring 1–512No
curl
curl -X POST 'https://www.notificado.co/api/onboardings/unsubscribe' \
  -b cookies.txt \
  -H 'origin: https://www.notificado.co' \
  -H 'content-type: application/json' \
  -d '{}'
TypeScript
const response = await fetch('https://www.notificado.co/api/onboardings/unsubscribe', {
  method: 'POST',
  headers: { 'content-type': 'application/json', origin: 'https://www.notificado.co', cookie: sessionCookie },
  body: JSON.stringify({}),
});
const result = await response.json();
Ejemplo de respuesta
200
{
  "ok": true
}

Errores

  • 400 X_INPUT_INVALID
  • 403 policy denied
  • 422 X_BODY_INVALID

signOut

POST/api/outs/sign

Miembro de la firmaPermiso: auth:sign-out

signOut

curl
curl -X POST 'https://www.notificado.co/api/outs/sign' \
  -b cookies.txt \
  -H 'origin: https://www.notificado.co' \
  -H 'content-type: application/json' \
  -d '{}'
TypeScript
const response = await fetch('https://www.notificado.co/api/outs/sign', {
  method: 'POST',
  headers: { 'content-type': 'application/json', origin: 'https://www.notificado.co', cookie: sessionCookie },
  body: JSON.stringify({}),
});
const result = await response.json();
Ejemplo de respuesta
200
{
  "ok": true
}

Errores

  • 400 X_INPUT_INVALID
  • 403 policy denied
  • 422 X_BODY_INVALID

requestPasswordReset

POST/api/password-resets/request

Sin sesiónPermiso: auth:anonymous

requestPasswordReset

Parámetros de requestPasswordReset
NombreDóndeTipoObligatorio
captchaTokenCuerpostring 0–4096No
cf-turnstile-responseCuerpostring 0–4096No
emailCuerpostring 0–320Sí
h-captcha-responseCuerpostring 0–4096No
localeCuerpostring 0–16No
curl
curl -X POST 'https://www.notificado.co/api/password-resets/request' \
  -H 'content-type: application/json' \
  -d '{"email":"<email>"}'
TypeScript
const response = await fetch('https://www.notificado.co/api/password-resets/request', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    "email": "<email>"
  }),
});
const result = await response.json();
Ejemplo de respuesta
200
{
  "ok": true
}

Errores

  • 400 X_INPUT_INVALID
  • 403 policy denied
  • 422 X_BODY_INVALID

resetPassword

POST/api/passwords/reset

Sin sesiónPermiso: auth:anonymous

resetPassword

Parámetros de resetPassword
NombreDóndeTipoObligatorio
passwordCuerpostring 0–1024Sí
passwordConfirmCuerpostring 0–1024No
tokenCuerpostring 0–2048Sí
curl
curl -X POST 'https://www.notificado.co/api/passwords/reset' \
  -H 'content-type: application/json' \
  -d '{"password":"<password>","token":"<token>"}'
TypeScript
const response = await fetch('https://www.notificado.co/api/passwords/reset', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    "password": "<password>",
    "token": "<token>"
  }),
});
const result = await response.json();
Ejemplo de respuesta
200
{
  "ok": true
}

Errores

  • 400 X_INPUT_INVALID
  • 403 policy denied
  • 422 X_BODY_INVALID

signUp

POST/api/ups/sign

Sin sesiónPermiso: auth:anonymous

signUp

Parámetros de signUp
NombreDóndeTipoObligatorio
captchaTokenCuerpostring 0–4096No
cf-turnstile-responseCuerpostring 0–4096No
emailCuerpostring 1–320Sí
h-captcha-responseCuerpostring 0–4096No
nameCuerpostring 1–200Sí
nextCuerpostring 0–2048No
orgNameCuerpostring 1–200Sí
passwordCuerpostring 1–1024Sí
referralCodeCuerpostring 0–40No
termsVersionCuerpostring 1–64No
curl
curl -X POST 'https://www.notificado.co/api/ups/sign' \
  -H 'content-type: application/json' \
  -d '{
  "email": "<email>",
  "name": "<name>",
  "orgName": "<orgName>",
  "password": "<password>"
}'
TypeScript
const response = await fetch('https://www.notificado.co/api/ups/sign', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    "email": "<email>",
    "name": "<name>",
    "orgName": "<orgName>",
    "password": "<password>"
  }),
});
const result = await response.json();
Ejemplo de respuesta
200
{
  "ok": true,
  "orgId": "<orgId>",
  "userId": "<userId>"
}

Errores

  • 400 X_INPUT_INVALID
  • 403 policy denied
  • 422 X_BODY_INVALID