POST /api/action/network-v1/update-suscription

PROD

Este webservice é usado para atualizar a assinatura do usuário na rede. As informações dos usuários devem ser obtidas por meio do serviço network/query-customers.

Informações do recurso
Autenticação	Obrigatória
Scope	`network-suscription`
Método HTTP	POST
Resposta	JSON
Versão	1

URL do recurso

https://mapaprop.app/api/action/network-v1/update-suscription

Parâmetros

Chave	Tipo	Obrigatório	Descrição
agencyId	string	sim	O ID da imobiliária fornecido pelos webservices GET /api/action/feed-v1/get-properties ou GET /api/action/feed-v1/get-delta da Feeds API. Formato: `ECID0011126701EN`
planDescription	string	sim	Uma descrição da assinatura do usuário. Por exemplo "Plano Plus 5 Publicações". Esse texto é exibido ao cliente.
planMaxPublications	int	sim	O número máximo de publicações permitidas pelo plano. Envie 0 (zero) para bloquear o usuário.
planCost	string	sim	O custo da assinatura. É uma string livre, portanto inclua o símbolo e a moeda. Esse texto é exibido ao usuário.
planBillingCycle	string	sim	Indica o ciclo de faturamento do plano, por exemplo "Semanal", "Mensal". Esse texto é exibido ao usuário.
planUpgradeURL	string	sim	A URL onde o usuário pode clicar para melhorar, cancelar ou modificar a assinatura.
listingURL	string	sim	A URL da sua rede com todos os imóveis do usuário. Por exemplo http://seusite.com/nelson-imoveis
accountStatus	string	sim	Um texto indicando o status atual da conta. Útil para mostrar se o usuário tem pagamento pendente, conta suspensa ou saldo disponível.

Código de exemplo

POST /api/action/network-v1/update-suscription HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

agencyId=ECID001126701EN&planDescription=PLUS%2010&planMaxPublications=10&planCost=%24%2033&planBillingCycle=SEMANAL
&planUpgradeURL=https%3A%2F%2Fmysite.com%2Fupgrade%3FagencyId%3DAIGIGI
&listingURL=https%3A%2F%2Fmysite.com%2Fjulian-inmobiliaria
&accountStatus=AL%20DIA

Resposta

A resposta JSON indica se a assinatura foi atualizada. Caso contrário, um código de erro indica o que ocorreu.

Objeto	Campo	Tipo	Obrigatório	Descrição
Response	success	boolean	sim	Um booleano indicando se a atualização foi bem-sucedida ou não
	error	string	não	Um texto indicando o tipo de erro quando success == false

Códigos de erro

Erro	Causa
`CHECK_YOUR_INPUT`	Falta um parâmetro obrigatório (por exemplo agencyId, planDescription ou planMaxPublications)
`INVALID_AGENCY_ID`	O agencyId não é válido
`CUSTOMER_DOES_NOT_HAVE_NETWORK`	O cliente não é membro da sua rede

Código de exemplo

{
    "success": false,
    "error": "CUSTOMER_DOES_NOT_HAVE_NETWORK"
}