Pesquisas e RespostasEnviar Pesquisa

Enviar Pesquisa

Envia uma solicitação de pesquisa de satisfação para um cliente via e-mail, SMS ou WhatsApp.

curl -X POST "https://api.amplifique.me/partners/cf" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY" \
  -d '{
  "name": "João da Silva",
  "email": "joao@example.com",
  "phone": "+5542999999999",
  "company": "Empresa Teste",
  "companyDocument": "00.000.000/0001-00",
  "channel": "email",
  "customerId": "123",
  "transactionId": "1234",
  "custom_fields": {
    "regiao": "Sul"
  },
  "expiration": 7
}'
{
  "_id": "62eabd08db91f8fba6ff2159",
  "customer": {
    "_id": "62eabbaeaea4eba9b7284549",
    "email": "joao@example.com",
    "phone": "+5542999613014"
  }
}
POST
/partners/cf
POST
API Key (header: Authorization)
Authorizationstring
Required

API key (sent in header)

Content-Typestring
Required

The media type of the request body

Options: application/json
namestring
Required

Nome e/ou Sobrenome do cliente

emailstring
Required

E-mail do cliente

phonestring

Telefone do cliente no padrão E.164

companystring

Opcional — Nome da empresa do cliente

companyDocumentstring

Opcional — CNPJ da empresa do cliente

channelstring

Opcional — Canal de envio. Opções: sms, email, wa-api. Para receber apenas o link no retorno, envie wa-link.

customerIdstring

Opcional — Identificador interno do cliente no seu sistema (ex: código do cliente)

transactionIdstring

Opcional — Identificador interno da transação (ex: código da venda)

custom_fieldsobject

Opcional — Objeto JSON com campos customizados adicionais

expirationinteger

Opcional — Expiração em dias do link da solicitação. Mínimo: 0, Máximo: 90.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

API Key for authentication. Provide your API key in the header.

Body

application/json
namestring
Required

Nome e/ou Sobrenome do cliente

emailstring
Required

E-mail do cliente

phonestring

Telefone do cliente no padrão E.164

companystring

Opcional — Nome da empresa do cliente

companyDocumentstring

Opcional — CNPJ da empresa do cliente

channelstring

Opcional — Canal de envio. Opções: sms, email, wa-api. Para receber apenas o link no retorno, envie wa-link.

customerIdstring

Opcional — Identificador interno do cliente no seu sistema (ex: código do cliente)

transactionIdstring

Opcional — Identificador interno da transação (ex: código da venda)

custom_fieldsobject

Opcional — Objeto JSON com campos customizados adicionais

expirationinteger

Opcional — Expiração em dias do link da solicitação. Mínimo: 0, Máximo: 90.

Responses

_idstring

ID da solicitação criada

customerobject