Criação e Alteração de Contatos

Contatos são dados de assinantes que auxiliam o processo de envio de envelopes no sistema. Se o CPF do contato já existir no momento da requisição, as informações do contato são atualizadas.

POST https://signhom.acesso.io/api/v1/service/contact

Headers

Name	Type	Description
Authorization*	string	Token de acesso adquirido pela plataforma Identity (bearer)

Request Body

Name	Type	Description
ContactName*	string	Nome do contato
ContactIdentifier	string	Identificador do contato
ContactPhone*	string	Telefone do contato. Necessário informar o código do país sem a adição do caractere especial "+" Ex: (55 + DDD + Número ) (Obrigatório se não houver e-mail)
ContactEmail*	string	Email do contato
ContactCPF*	string	CPF do contato

200 Contato criado com sucesso

{
    "Success": true,
    "Message": "Contato criado com sucesso",
    "Data": null
}

401 O Token está expirado ou sem permissão.

500 Quando algo estiver incorreto, o detalhe do problema será retornado no campo Message.

{
    "Success": false,
    "Message": "Falha ao criar o contato.",
    "Data": "CPF Inválido"
}

400: Bad Request Quando alguma propriedade estiver incorreta, onde será retornado um json contendo o campo e o erro de validação.

{
	"errors":
	[
		{"key": "NomeCampo1", "message": "Problema da validação"},
		{"key": "NomeCampo2", "message": "Problema da validação"},
	]
}

Exemplo de Requisição

{
    "ContactName" : "Nome Contato",
    "ContactCPF" : "10000000019",
    "ContactEmail": "[e-mail]",
    "ContactPhone": "5511999999999"
}