1. Ayuda
  2. Cómo trabajar por API con sender-solutions.com
  3. 9. Descripción de la solicitud a la API: creación de un suscriptor con confirmación de la intención de suscripción

9. Descripción de la solicitud a la API: creación de un suscriptor con confirmación de la intención de suscripción

9. Descripción de la solicitud a la API: creación de un suscriptor con confirmación de la intención de suscripción

El método está destinado a la creación de un nuevo suscriptor en el proyecto con confirmación de la suscripción por el propio suscriptor. Esto se adapta bien a los formularios de suscripción públicos en sitios web, donde se puede introducir cualquier Email. El sistema Sender Solutions enviará a dicho suscriptor un correo para que confirme por separado que quiere recibir el envío. Esto protegerá la base de suscriptores frente a errores accidentales o intencionados al introducir el Email. Los datos se transmiten en formato application/json.

Solicitud HTTP
  • URL: https://sender-solutions.com/api/subscribers/subscribe-action/
  • Método HTTP: POST
  • Content-Type: application/json
Cuerpo de la solicitud (JSON)
{
    "Subscriber": {
        "Base": {
            "Id": 0,
            "Name": "Test Users"
        },
        "IsActive": true,
        "Email": "username@example.com",
        "FirstName": "Cat",
        "LastName": "Catstone",
        "Tags": ["api", "test-user"],
        "ClientUserId": "ClientUserId3",
        "CustomField1": "CustomValue1",
        "CustomField2": "CustomValue2",
        "CustomField3": "CustomValue3",
        "Address": {
            "Country": "UA",
            "City": "Odesa",
            "State": null,
            "Zip": 65000,
            "Line1": "Very Long street",
            "Line2": "building 42",
            "Line3": null
        }
    },
    "PreferredLanguage": "uk"
}
Ejemplo de solicitud usando cURL

curl --location 'https://sender-solutions.com/api/subscribers/subscribe-action/' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{api-token}}' \
--data-raw '{
    "Subscriber": {
        "Base": {
            "Id": 0,
            "Name": "Test Users"
        },
        "IsActive": true,
        "Email": "username@example.com",
        "FirstName": "Cat",
        "LastName": "Catstone",
        "Tags": ["api", "test-user"],
        "ClientUserId": "ClientUserId3",
        "CustomField1": "CustomValue1",
        "CustomField2": "CustomValue2",
        "CustomField3": "CustomValue3",
        "Address": {
            "Country": "UA",
            "City": "Odesa",
            "State": null,
            "Zip": 65000,
            "Line1": "Very Long street",
            "Line2": "building 42",
            "Line3": null
        }
    },
    "PreferredLanguage": "uk"
}'
Descripción de los campos
Campo Tipo Obligatorio Descripción
Subscriber.Base.Id number Identificador de la Base de suscriptores. Debe indicarse obligatoriamente este campo o Subscriber.Base.Name. Si se transmiten valores no vacíos en ambos campos, la prioridad es para Subscriber.Base.Id
Subscriber.Base.Name string Nombre de la Base de suscriptores. Debe indicarse obligatoriamente este campo o Subscriber.Base.Id. Si se transmiten valores no vacíos en ambos campos, la prioridad es para Subscriber.Base.Id
Subscriber.IsActive boolean Indicador de actividad del suscriptor. Tras la confirmación de la suscripción, el suscriptor estará activo. Este campo se puede ignorar.
Subscriber.Email string Email del suscriptor
Subscriber.FirstName string Nombre
Subscriber.LastName string Apellido
Subscriber.Gender string Sexo del suscriptor. Valores posibles: "male" para masculino, "female" para femenino, ""(cadena vacía) para el valor "No indicado". Por defecto "No indicado"
Subscriber.Phone string Número de teléfono
Subscriber.Tags array[string] Tags del suscriptor, array de cadenas
Subscriber.ClientUserId string ID del suscriptor en el sistema del cliente
Subscriber.CustomField1 string Campo libre 1, rellene con cualquier información a su criterio.
Subscriber.CustomField2 string Campo libre 2, rellene con cualquier información a su criterio.
Subscriber.CustomField3 string Campo libre 3, rellene con cualquier información a su criterio.
Subscriber.Address.Country string Código de país de dos caracteres (ISO 3166-1 alpha-2)
Subscriber.Address.City string Ciudad
Subscriber.Address.State string | null Región / estado / provincia
Subscriber.Address.Zip number Código postal
Subscriber.Address.Line1 string Línea principal de la dirección
Subscriber.Address.Line2 string Línea adicional de la dirección
Subscriber.Address.Line3 string | null Línea adicional de la dirección
Subscriber.Birthday string (YYYY-MM-DD) Fecha de nacimiento en formato YYYY-MM-DD
PreferredLanguage string Código del idioma preferido para usar en el correo al suscriptor en formato ISO 639-1. Debe contener 2 letras latinas minúsculas (por ejemplo: en, uk, ru). Por defecto en
Ejemplo de respuesta exitosa. La obtención de una respuesta exitosa significa que se le envió al suscriptor un correo con la confirmación de la suscripción. Debe seguir el enlace del correo y confirmar la intención de suscripción.
{
    "success": true
}