1. Ayuda
  2. Cómo trabajar por API con sender-solutions.com
  3. 1. Creación de un suscriptor mediante la API

1. Creación de un suscriptor mediante la API

1. Creación de un suscriptor mediante la API

El método está destinado a la creación de un nuevo suscriptor en el proyecto. Los datos se transmiten en formato application/json.

Solicitud HTTP
  • URL: https://sender-solutions.com/api/subscribers/create-subscriber/
  • 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",
        "Gender": "male",
        "Phone": "+380111222333",
        "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
        },
        "Birthday": "2002-04-15"
    }
}
Ejemplo de solicitud usando cURL

curl --location 'https://sender-solutions.com/api/subscribers/create-subscriber/' \
--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",
        "Gender": "male",
        "Phone": "+380111222333",
        "Tags": ["api", "test-user"],
        "ClientUserId": "ClientUserId12345",
        "CustomField1": "CustomValue1",
        "CustomField2": "CustomValue2",
        "CustomField3": "CustomValue3",
        "Address": {
            "Country": "UA",
            "City": "Odesa",
            "State": null,
            "Zip": 65000,
            "Line1": "Very Long street",
            "Line2": "building 42",
            "Line3": null
        },
        "Birthday": "2002-04-15"
    }
}'
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. Por defecto false.
Subscriber.Email string Email del suscriptor
Subscriber.FirstName string Nombre
Subscriber.LastName string Apellido
Subscriber.Gender string Sexo del suscriptor. Valores posibles: "male" — masculino, "female" — femenino, "" (cadena vacía) — «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 personalizado 1. Rellene con cualquier información a su propio criterio.
Subscriber.CustomField2 string Campo personalizado 2. Rellene con cualquier información a su propio criterio.
Subscriber.CustomField3 string Campo personalizado 3. Rellene con cualquier información a su propio 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
Ejemplo de respuesta exitosa. Contiene los datos del suscriptor creado en la misma estructura que la solicitud a la API. También contiene el campo adicional Subscriber.Id — identificador del suscriptor creado.
{
    "success": true,
    "Subscriber": {
        "Id": 24,
        "Base": {
            "Id": 13,
            "Name": "Test Users"
        },
        "IsActive": true,
        "Email": "username@example.com",
        "FirstName": "Cat",
        "LastName": "Catstone",
        "Gender": "male",
        "Phone": "+380111222333",
        "Tags": [
            "api",
            "test-user"
        ],
        "ClientUserId": "ClientUserId12345",
        "CustomField1": "CustomValue1",
        "CustomField2": "CustomValue2",
        "CustomField3": "CustomValue3",
        "Address": {
            "Country": "UA",
            "City": "Odesa",
            "State": "",
            "Zip": "65000",
            "Line1": "Very Long street",
            "Line2": "building 42",
            "Line3": ""
        },
        "Birthday": "2002-04-15"
    }
}