Adicionar nota

post/notes

Request

Base URL
https://api.pipe.run/v1
Auth
API key in header token
TypeScript
https://skmtc.dev/pipe/apis/application-json/docs/notes/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

textstring required

Texto da nota.

user_idinteger

ID do usuário do PipeRun responsável pela nota.

deal_idinteger

ID da oportunidade, caso a nota seja vinculada à uma oportunidade.

company_idinteger

ID da empresa, caso a nota seja vinculada à uma empresa.

person_idinteger

ID da pessoa, caso a nota seja vinculada à uma pessoa.

call_idinteger

ID da chamada, caso a nota seja um comentário de uma chamada.

Response

201

successboolean

messagestring

Example response

{
  "success": true,
  "message": "Created",
  "data": {
    "id": 123456987,
    "account_id": 15222,
    "user_id": 123456,
    "user_name": "TESTE",
    "text": "Cliente relatou que só contratará o serviço se o modo de pagamento for em cartão de crédito.",
    "created_at": "2023-01-11 10:02:36"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.