Sign in

v1

latestOpenAPI 3.0.02026-07-26626596.3 KB
Atividades

Atualizar atividade

patch/api/v1/activities/{id}

Path parameters

idstring required

Request body

titlestring

Título da atividade (não obrigatório na atualização).

descriptionstring

Descrição da atividade.

startDatestring date-time

Filtro de intervalo, negócios que estão em negociação ou estavam em negociação em determinado intervalo. Formato (ISO 8601): YYYY-MM-DDTHH:mm:ss.sssZ

endDatestring date-time

Filtro de intervalo, negócios que estão em negociação ou estavam em negociação em determinado intervalo. Formato (ISO 8601): YYYY-MM-DDTHH:mm:ss.sssZ

requiredboolean

Valor boneano que indica se a atividade é obrigatória ou não

linkToStageboolean

Valor boneano que indica se a atividade deve ser vinculada a etapa do negócio ou não

Example request

{
  "title": "Follow-up via e-mail",
  "description": "Negociar preços com o cliente",
  "startDate": "2025-10-09T03%3A00%3A00.000Z",
  "endDate": "2025-10-09T03%3A00%3A00.000Z",
  "attendant": {
    "userId": "t9kn9mqPakdGG535GQK3hod8wzM2",
    "id": "6807e48c25ece34f9f1ba7dd",
    "name": "Joao Silva",
    "email": "joaosilva@gmail.com",
    "phone": "5547991331190",
    "imageURL": "https://dc-qqqq1111pb.s3.amazonaws.com/profiles/koQGLa8p68fNZiiSmE1tec2LHtc2_2025-05-24T00%3A27%3A23.486Z"
  },
  "lead": {
    "id": "15b41959-b04d-4a99-b878-6e45fffa7633"
  },
  "business": {
    "id": "e9a09677-cf00-4d84-aa12-6d78d6786555"
  },
  "activityType": {
    "id": "e9a09677-cf00-4d84-aa12-6d78d6786555"
  },
  "flow": {
    "id": "8fcd6ff0-6b45-40e3-8e7d-abd456a5a459"
  }
}

Response

idstring

ID da atividade.

createdAtstring date-time

Data de criação da atividade.

titlestring required

Título da atividade.

descriptionstring

Descrição da atividade.

startDatestring date-time

Filtro de intervalo, negócios que estão em negociação ou estavam em negociação em determinado intervalo. Formato (ISO 8601): YYYY-MM-DDTHH:mm:ss.sssZ

endDatestring date-time

Filtro de intervalo, negócios que estão em negociação ou estavam em negociação em determinado intervalo. Formato (ISO 8601): YYYY-MM-DDTHH:mm:ss.sssZ

isCompletedboolean

Valor boneano que indica se a atividade está concluida ou não

requiredboolean

Valor boneano que indica se a atividade é obrigatória ou não

Example response

{
  "id": "e9a09677-cf00-4d84-aa12-6d78d6786555",
  "createdAt": "2025-06-18T22:18:36.666Z",
  "title": "Reunião online",
  "description": "Negociar preços com o cliente",
  "startDate": "2025-10-09T03%3A00%3A00.000Z",
  "endDate": "2025-10-09T03%3A00%3A00.000Z",
  "lead": {
    "id": "15b41959-b04d-4a99-b878-6e45fffa7633",
    "createdAt": "2025-06-11T18:31:25.203Z",
    "name": "Guilherme Gavazzoni",
    "image": "https://dc-qqqq2222pb.s3.amazonaws.com/0a7ac87c-2f50-46b5-9c39-80ffec53e633/1163f5c2-62f4-443f-a84f-9c223b05ae3b",
    "phone": "+55 (47) 991331190",
    "rawPhone": "5547991331190",
    "email": "guilherme@datacrazy.com.br",
    "source": "Google ads",
    "company": "Apple",
    "taxId": "108.154.702-92",
    "site": "www.meulead.com.br",
    "instagram": "@guilhermegavazzoni",
    "tags": {
      "id": "cb3e8d24-ccad-43d1-acd5-08580d9bc674",
      "name": "marketing orgânico",
      "color": "#A78BFA",
      "description": "Leads que vieram de campanhas internas",
      "createdAt": "2025-03-25T14:12:47.738Z"
    },
    "lists": [
      {
        "id": "5343afav-e697-4720-9303-e788c23711dd",
        "name": "ativos",
        "color": "#EB2626",
        "description": "lista de compradores recorrentes",
        "createdAt": "2025-06-12T17:37:17.861Z"
      },
      {
        "id": "f2b3c92d-3843-406f-a3e3-672d2d7d2a27",
        "name": "inativos",
        "color": "#EB2626",
        "description": "lista de compradores de baixa frequência",
        "createdAt": "2025-12-03T17:28:09:5361Z"
      }
    ],
    "attendant": {
      "userId": "t9kn9mqPakdGG535GQK3hod8wzM2",
      "id": "6807e48c25ece34f9f1ba7dd",
      "name": "Joao Silva",
      "email": "joaosilva@gmail.com",
      "phone": "5547991331190",
      "imageURL": "https://dc-qqqq1111pb.s3.amazonaws.com/profiles/koQGLa8p68fNZiiSmE1tec2LHtc2_2025-05-24T00%3A27%3A23.486Z"
    },
    "sourceReferral": {
      "sourceId": "2bc3d979-93a4-4e64-8903-5d9379d3de91",
      "sourceUrl": "https://example.com/artigo-de-origem",
      "ctwaId": "849fefab-e697-4720-9303-e788c23790cc"
    }
  },
  "business": {
    "id": "e9a09677-cf00-4d84-aa12-6d78d6786555",
    "createdAt": "2025-06-18T22:18:36.666Z",
    "stageId": "e6803a51-4bd6-416b-b516-3622ff256732",
    "leadId": "c1152508-fdfd-4905-a3f4-f3850cc00bf0",
    "attendantId": "7e7da46a-a0ed-43c2-a3aa-3ac253f41b4d",
    "nextActivityId": "3d3d23a-a0ed-43c2-a3aa-3ac23433f41g01",
    "discount": 500,
    "shipping": 2000,
    "coupon": "CUPOM100",
    "shippingType": "Sedex",
    "status": "in_process",
    "code": 50607,
    "externalId": "f33420908-dcdc-4905-a3f4-f3850cc43bf0",
    "lastMovedAt": "2025-06-18T22:18:36.611Z",
    "statusChangedAt": "2025-06-18T22:20:14.611Z4",
    "products": [],
    "lossReasonId": "null",
    "productsCount": 2
  },
  "attendant": {
    "userId": "t9kn9mqPakdGG535GQK3hod8wzM2",
    "id": "6807e48c25ece34f9f1ba7dd",
    "name": "Joao Silva",
    "email": "joaosilva@gmail.com",
    "phone": "5547991331190",
    "imageURL": "https://dc-qqqq1111pb.s3.amazonaws.com/profiles/koQGLa8p68fNZiiSmE1tec2LHtc2_2025-05-24T00%3A27%3A23.486Z"
  },
  "activityType": {
    "id": "e9a09677-cf00-4d84-aa12-6d78d6786555",
    "name": "Reunião presencial",
    "color": "#FF2200"
  },
  "flow": {
    "id": "8fcd6ff0-6b45-40e3-8e7d-abd456a5a459",
    "name": "Fluxo de mensagens de boas-vindas",
    "description": "Automação disparada para clientes não cadastrados na base",
    "createdAt": "2025-09-09T16:27:15.522Z",
    "updatedAt": "2025-09-09T16:27:15.522Z",
    "group": "1"
  }
}