Funis
Dentro da estratégia de Marketing de Conteúdo existem estágios importantes, afinal nem todos os seus contatos possuem o mesmo interesse ou estão na mesma fase de relacionamento com seu produto e/ou empresa.
Esses estágios e a transição entre eles formam o que chamamos de funil de vendas, que também pode ser chamado funil do Marketing, no qual o volume de pessoas que chegam no topo (visitantes) vai diminuindo ao longo do processo de venda até se tornarem clientes, no fundo do funil.
A API de funis permite que você manipule os estágios de funil de seus contatos, atualmente eles podem ser classificados como: Lead, Lead Qualificado e Cliente.
Métodos disponíveis
Returns a list of Funnels associated to the given contact.
Request Parameter
uuid | String | The unique uuid associated to RD Station Contact. |
---|---|---|
funnel_name | String | The contact funnel name. For now, the only accepted option is: "default". |
Response Body
Field | Type | Description |
---|---|---|
lifecycle_stage | String | The stage in the funnel which the contact belongs to. Valid options: 'Lead', 'Qualified Lead' and 'Client'. |
opportunity | Boolean | It indicates whether the contact is an opportunity or not in the funnel. |
contact_owner_email | String | The email of the user responsible for the contact. |
fit | Integer | The contact fit score in the current funnel. |
interest | Integer | The contact interest score in the current funnel. |
Example:
Code: 200
{
"lifecycle_stage": "Client",
"opportunity": true,
"contact_owner_email": "email@example.org",
"fit": 60,
"interest": 100
}
Returns a list of Funnels associated to the given contact.
Request Parameter
String | The email associated to RD Station Contact. | |
funnel_name | String | The contact funnel name. For now, the only accepted option is: "default". |
Response Body
Field | Type | Description |
---|---|---|
lifecycle_stage | String | The stage in the funnel which the contact belongs to. Valid options: 'Lead', 'Qualified Lead' and 'Client'. |
opportunity | Boolean | It indicates whether the contact is an opportunity or not in the funnel. |
contact_owner_email | String | The email of the user responsible for the contact. |
fit | Integer | The contact fit score in the current funnel. |
interest | Integer | The contact interest score in the current funnel. |
Example:
Code: 200
{
"lifecycle_stage": "Client",
"opportunity": true,
"contact_owner_email": "email@example.org",
"fit": 60,
"interest": 100
}
Updates the funnel information about the current contact.
Request body parameters
Field | Type | Description |
---|---|---|
lifecycle_stage | String | The stage in the funnel which the contact belongs to. Valid options: 'Lead', 'Qualified Lead' and 'Client'. |
opportunity | Boolean | It indicates whether the contact is an opportunity or not in the funnel. |
contact_owner_email | String | The email of the user responsible for the contact. Can be defined as null for disassociate the current owner. |
Validations
Attributes validations:
Field | Error type | Rule |
---|---|---|
lifecycle_stage | CANNOT_BE_NULL | lifecycle_stage cannot be null |
lifecycle_stage | MUST_BE_STRING | lifecycle_stage must be string |
lifecycle_stage | MUST_BE_LESS_THAN_OR_EQUAL | lifecycle_stage must less than or equal to 50 |
lifecycle_stage | MUST_BE_VALID_OPTION | invalid options for lifecycle_stage, the valid options are: 'Lead', 'Qualified Lead', 'Client' |
opportunity | CANNOT_BE_NULL | opportunity cannot be null |
opportunity | MUST_BE_BOOLEAN | opportunity must be boolean |
contact_owner_email | MUST_BE_STRING | contact_owner_email must be string |
contact_owner_email | MUST_BE_LESS_THAN_OR_EQUAL | contact_owner_email must less than or equal to 100 |
contact_owner_email | INVALID_EMAIL_FORMAT | contact_owner_email has an invalid format |
contact_owner_email | INVALID_USER | The user {user} was not found in your account. |
Request body example
{
"lifecycle_stage": "Client",
"opportunity": true,
"contact_owner_email": "email@example.org"
}
Response examples:
Success | Code: 200
{
"lifecycle_stage": "Client",
"opportunity": true,
"contact_owner_email": "email@example.org",
"fit": 60,
"interest": 100
}
Error | Code: 400
Attributes errors
{
"errors": {
"lifecycle_stage": [
{
"error_type": "CANNOT_BE_NULL",
"error_message": "lifecycle_stage cannot be null"
},
{
"error_type": "MUST_BE_STRING",
"error_message": "lifecycle_stage must be string"
},
{
"error_type": "MUST_BE_LESS_THAN_OR_EQUAL",
"error_message": "lifecycle_stage must less than or equal to 50"
},
{
"error_type": "MUST_BE_VALID_OPTION",
"error_message": "invalid options for lifecycle_stage, the valid options are: 'Lead', 'Qualified Lead' and 'Client'"
}
],
"opportunity": [
{
"error_type": "CANNOT_BE_NULL",
"error_message": "opportunity cannot be null"
},
{
"error_type": "MUST_BE_BOOLEAN",
"error_message": "opportunity must be boolean"
}
],
"contact_owner_email": [
{
"error_type": "MUST_BE_STRING",
"error_message": "url must be string"
},
{
"error_type": "MUST_BE_LESS_THAN_OR_EQUAL",
"error_message": "url must less than or equal to 100"
},
{
"error_type": "INVALID_EMAIL_FORMAT",
"error_message": "contact_owner_email has an invalid format"
},
{
"error_type": "INVALID_USER",
"error_message": "The user {user} was not found in your account."
}
]
}
}