MailingBoss 5.0 - Integração API

Localize o Token - chave de integração para autenticação.

O Token necessário para autenticação das solicitações para a API é encontrado na seção "Chave de Integração" do MailingBoss 5.0.

Acesse no menu lateral do MailingBoss 5.0 a opção de "Integração": 

Clique em "Copiar" ou selecione e copie (CTRL+C) a chave de integração para colar em outra ferramenta ou no código requerido.

Chave de Integração - MailingBoss 5.0

2. Método para pesquisar as listas: 

Para obter todas as listas de usuários, é necessário fazer uma solicitação GET para a URL:  https://member.mailingboss.com/integration/index.php/lists/<TOKEN>:

Exemplo de solicitação GET:

GET /integration/index.php/lists/<TOKEN>
HOST: https://member.mailingboss.com

Exemplo de resposta JSON:

{
	status: "success", data: [
			{
				list_uid: "m07ug174cie26",
				name: "E-mail Marketing",
				display_name: "E-mail Marketing",
				description: "E-mail Marketing"
			},
			{
				list_uid: "mj546z2pwp2de",
				name: "Form name / List Test",
				display_name: "List Test",
				description: "List Test"
			}
			]
}

3. Método para obter os campos personalizados:

Para obter todos os campos personalizados, é necessário fazer uma solicitação POST para a URL: https://member.mailingboss.com/integration/index.php/lists/fields/<TOKEN>:

Exemplo de solicitação POST:

POST /integration/index.php/lists/fields/<TOKEN>
HOST: https://member.mailingboss.com
PARAMS – FORM DATA or JSON:
    list_uid: STRING Ex: vh485p76so057

Exemplo de resposta JSON:

{
	status: "success",
	data: [
			{
				label: "Email",
				tag: “EMAIL",
				type: “text”,
				required: “yes”,
				options: []
			},
			{
				label: "Gender",
				tag: “GENDER",
				type: “dropdown”,
				required: “no”,
				options: [
					{
							name: “Male”,
							value: "male"
					},
					{
							name: “Female”,
							value: "female"
					}
				]
			}
			]
}

Requisições JSON: Observe que o cabeçalho da requisição deve especificar o tipo de requisição, como exemplo: "Content-Type: application/json".

4. Adicionar um inscrito (lead) a lista:

Para associar um lead a uma lista, é necessário fazer uma solicitação POST a URL: https://member.mailingboss.com/integration/index.php/lists/subscribers/create/<TOKEN>
passando os campos: email, list_uid e taginternals.

Atenção! Para evitar possíveis erros, NÃO adicione todos os parâmetros na URL. A URL deve conter APENAS o TOKEN, os demais parâmetros devem ser configurados no local onde coletou a informação.

Exemplo de solicitação POST:

POST /integration/index.php/lists/subscribers/create/<TOKEN>
HOST: https://member.mailingboss.com
PARAMS – FORM DATA or JSON:
    email: STRING Ex: teste@teste.com
    list_uid: STRING Ex: vh485p76so057
    taginternals: STRING Ex: testetag, tag2

Exemplo de resposta JSON:

{
	status: "success",
	data: {
			subscriber_uid: "ow305e5oat103",
			email: "teste@teste.com", taginternals:
			"testetag, tag2", status: "confirmed"
	}
}

Exemplo de solicitação POST usando campos personalizados:

POST /integration/index.php/lists/subscribers/create/<TOKEN>
HOST: https://member.mailingboss.com
PARAMS – FORM DATA or JSON:
    email: STRING Ex: teste@teste.com
    list_uid: STRING Ex: vh485p76so057
    taginternals: STRING Ex: testetag, tag2
    gender: STRING VALUE
    fname: STRING VALUE
    lname: STRING VALUE

Exemplo de resposta JSON:

{
	status: "success",
	data: {
			subscriber_uid: "ow305e5oat103",
			email: "teste@teste.com", taginternals:
			"testetag, tag2", status: "confirmed"
	}
}

Requisições JSON: Observe que o cabeçalho da requisição deve especificar o tipo de requisição, como exemplo: "Content-Type: application/json".

5. Procurar inscrito (lead) por email: 

Para procurar um lead por email, é necessário fazer uma solicitação POST para a URL: https://member.mailingboss.com/integration/index.php/lists/subscribers/search-by-email/<TOKEN>
passando os campos: email e list_uid.

Exemplo de solicitação POST:

POST /integration/index.php/lists/subscribers/search-by-email/<TOKEN>
HOST: https://member.mailingboss.com
PARAMS – FORM DATA or JSON:
    email: STRING Ex: teste@teste.com
    list_uid: STRING Ex: vh485p76so057

Exemplo de resposta JSON:

{
	status: "success",
	data: {
			email: "teste@teste.com", status:
			"confirmed", subscriber_uid:
			"ow305e5oat103", taginternals:
			"testetag, tag2"
	}
}

Requisições JSON: Observe que o cabeçalho da requisição deve especificar o tipo de requisição, como exemplo: "Content-Type: application/json".

6. Atualizar dados do lead:

Você pode alterar as informações de email, tags e valores de campo de um lead por uma solicitação POST para a URL: https://member.mailingboss.com/integration/index.php/lists/subscribers/update/<TOKEN>
passando os campos: subscriber_uid (opcional), list_uid, email, taginternals.

Exemplo de solicitação POST:

POST /integration/index.php/lists/subscribers/update/<TOKEN>
HOST: https://member.mailingboss.com
PARAMS – FORM DATA or JSON:
    subscriber_uid: STRING Ex: ho984vsr8af13
    list_uid: STRING Ex: vh485p76so057
    email: STRING Ex: teste@teste.com
    taginternals: STRING Ex: testetag, tag2
    taginternals_remove: STRING Ex: tag1

Exemplo de resposta JSON:

{
	status: "success"
}

Exemplo de solicitação POST usando campos personalizados:

POST /integration/index.php/lists/subscribers/update/<TOKEN>
HOST: https://member.mailingboss.com
PARAMS – FORM DATA or JSON:
    subscriber_uid: STRING Ex: ho984vsr8af13
    list_uid: STRING Ex: vh485p76so057
    email: STRING Ex: teste@teste.com
    taginternals: STRING Ex: testetag, tag2
    taginternals_remove: STRING Ex: tag1
    gender: STRING VALUE
    fname: STRING VALUE
    lname: STRING VALUE

Exemplo de resposta JSON:

{
	status: "success"
}

Requisições JSON: Observe que o cabeçalho da requisição deve especificar o tipo de requisição, como exemplo: "Content-Type: application/json".

7. Cancelar inscrição do lead em uma lista:

Para cancelar a inscrição de um lead em uma lista específica, faça uma solicitação POST para a URL: https://member.mailingboss.com/integration/index.php/lists/subscribers/unsubscribe/<TOKEN>
passando os campos: subscriber_uid e list_uid.

Exemplo de solicitação POST:

POST /integration/index.php/lists/subscribers/unsubscribe/<TOKEN>
HOST: https://member.mailingboss.com
PARAMS – FORM DATA or JSON:
    subscriber_uid: STRING Ex: ho984vsr8af13
    list_uid: STRING Ex: vh485p76so057

Exemplo de resposta JSON:

{
	status: "success"
}

Requisições JSON: Observe que o cabeçalho da requisição deve especificar o tipo de requisição, como exemplo: "Content-Type: application/json".

8. Deletar inscrito (lead) de uma lista:

Para cancelar a inscrição de um lead em uma lista específica, faça uma solicitação POST para o URL https://member.mailingboss.com/integration/index.php/lists/subscribers/unsubscribe/<TOKEN> passando os campos subscriber_uid e list_uid:

Exemplo de solicitação POST:

POST /integration/index.php/lists/subscribers/delete/<TOKEN>
HOST: https://member.mailingboss.com
PARAMS – FORM DATA or JSON:
    subscriber_uid: STRING Ex: ho984vsr8af13
    list_uid: STRING Ex: vh485p76so057

Exemplo de resposta JSON:

{
	status: "success"
}

Requisições JSON: Observe que o cabeçalho da requisição deve especificar o tipo de requisição, como exemplo: "Content-Type: application/json".

Avalie a nossa Central de Ajuda, sua opinião é importante para nós!