1. Ajuda
  2. Como trabalhar via API com sender-solutions.com
  3. 1. Criação de um assinante por meio da API

1. Criação de um assinante por meio da API

1. Criação de um assinante por meio da API

O método é destinado à criação de um novo assinante no projeto. Os dados são transmitidos no formato application/json.

Requisição HTTP
  • URL: https://sender-solutions.com/api/subscribers/create-subscriber/
  • Método HTTP: POST
  • Content-Type: application/json
Corpo da requisição (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"
    }
}
Exemplo de requisição 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"
    }
}'
Descrição dos campos
Campo Tipo Obrigatório Descrição
Subscriber.Base.Id number Identificador da base de assinantes. Obrigatoriamente deve ser indicado este campo ou Subscriber.Base.Name. Se forem transmitidos valores não vazios em ambos os campos, a prioridade é dada a Subscriber.Base.Id.
Subscriber.Base.Name string Nome da base de assinantes. Obrigatoriamente deve ser indicado este campo ou Subscriber.Base.Id. Se forem transmitidos valores não vazios em ambos os campos, a prioridade é dada a Subscriber.Base.Id.
Subscriber.IsActive boolean Indicador de atividade do assinante. Por padrão false.
Subscriber.Email string Email do assinante
Subscriber.FirstName string Nome
Subscriber.LastName string Sobrenome
Subscriber.Gender string Sexo do assinante. Valores possíveis: "male" — masculino, "female" — feminino, "" (string vazia) — «Não indicado». Por padrão — «Não indicado».
Subscriber.Phone string Número de telefone
Subscriber.Tags array[string] Tags do assinante, array de strings
Subscriber.ClientUserId string ID do assinante no sistema do cliente
Subscriber.CustomField1 string Campo personalizado 1. Preencha com qualquer informação a seu critério.
Subscriber.CustomField2 string Campo personalizado 2. Preencha com qualquer informação a seu critério.
Subscriber.CustomField3 string Campo personalizado 3. Preencha com qualquer informação a seu critério.
Subscriber.Address.Country string Código do país de dois caracteres (ISO 3166-1 alpha-2)
Subscriber.Address.City string Cidade
Subscriber.Address.State string | null Região / estado / província
Subscriber.Address.Zip number Código postal
Subscriber.Address.Line1 string Linha principal do endereço
Subscriber.Address.Line2 string Linha adicional do endereço
Subscriber.Address.Line3 string | null Linha adicional do endereço
Subscriber.Birthday string (YYYY-MM-DD) Data de nascimento no formato YYYY-MM-DD
Exemplo de resposta bem-sucedida. Contém os dados do assinante criado na mesma estrutura que a requisição API. Contém também o campo adicional Subscriber.Id — identificador do assinante criado.
{
    "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"
    }
}