Skip to main content
POST

Authorizations

Authorization
string
header
required

Chave de integração com prefixo wegly_, enviada em Authorization: Bearer . Não é JWT. A chave deve estar ativa, não excluída e dentro da validade. Com allowed_domain, Origin (ou Referer na ausência de Origin) precisa informar o hostname permitido. A empresa e as permissões são obtidas pela chave.

Body

application/json

crm_task_type_id e title são obrigatórios. Envie no máximo um vínculo entre crm_lead_id, crm_deal_id, crm_delivery_id, crm_person_id, crm_organization_id e crm_customer_id.

crm_task_type_id
string<uuid>
required
title
string
required
Required string length: 1 - 100
crm_task_stage_id
string<uuid>

Etapa da tarefa. Quando omitida, assume a primeira etapa ativa que não seja de conclusão; uma etapa de conclusão cria a tarefa já concluída.

responsible_id
string<uuid>

Usuário responsável. Quando omitido, assume o usuário criador da chave.

crm_lead_id
string<uuid>

Vincula a tarefa a um lead.

crm_deal_id
string<uuid>

Vincula a tarefa a uma oportunidade.

crm_delivery_id
string<uuid>

Vincula a tarefa a uma entrega.

crm_person_id
string<uuid>

Vincula a tarefa a uma pessoa.

crm_organization_id
string<uuid>

Vincula a tarefa a uma organização.

crm_customer_id
string<uuid>

Vincula a tarefa a um cliente.

priority
enum<integer>

Prioridade da tarefa: 0 baixa, 1 normal, 2 alta, 3 urgente.

Available options:
0,
1,
2,
3
description
string

Texto simples ou HTML. O HTML é higienizado: são mantidos formatação básica, listas, tabelas e links; scripts, imagens e conteúdo incorporado são removidos.

mentions
object[]
start_date
string<date-time> | null
end_date
string<date-time> | null

Exige start_date. Quando omitido, é calculado pela duração padrão do tipo de tarefa.

has_time
boolean

Com false, a tarefa vale para o dia inteiro e não aceita end_date.

recurrence
object
meeting_outcome
enum<integer>

Resultado da reunião: 1 = realizada, 2 = não compareceu, 3 = cancelada, 4 = reagendada. Aceito apenas em tarefas cujo tipo é reunião.

Available options:
1,
2,
3,
4
meeting_outcome_notes
string
is_personal
boolean
create_meeting
boolean
create_event
boolean
meeting_provider
enum<string>

Provedor de reunião online usado pela tarefa.

Available options:
teams_integration,
google_calendar_integration
meeting_participants
string<email>[]

E-mails são normalizados com trim e letras minúsculas.

Maximum array length: 100
Maximum string length: 320
reminders_minutes
integer[]

Minutos de antecedência dos lembretes. Exige tarefa com data e hora.

Required range: x >= 1
parent_task_id
string<uuid> | null

Tarefa pai. Subtarefas não podem ter recorrência própria.

tag_ids
string<uuid>[]

IDs das tags da tarefa.

meeting_mode
enum<string>
Available options:
online,
in_person
meeting_location
string | null

Obrigatório para meeting_mode=in_person. Local não permitido para modo online.

Required string length: 1 - 500
meeting_description
string

Descrição HTML com formatação básica; máximo de 5.000 caracteres de texto normalizado.

Maximum string length: 20000

Response

Tarefa criada com sucesso.

id
string<uuid>
title
string
description
string | null
is_personal
boolean
priority
enum<integer>

Prioridade da tarefa: 0 baixa, 1 normal, 2 alta, 3 urgente.

Available options:
0,
1,
2,
3
start_date
string<date-time> | null
end_date
string<date-time> | null
has_time
boolean
completed_at
string<date-time> | null
meeting_outcome
enum<integer> | null

Resultado da reunião: 1 = realizada, 2 = não compareceu, 3 = cancelada, 4 = reagendada.

Available options:
1,
2,
3,
4
meeting_outcome_notes
string | null
ai_processed
boolean
ai_status
integer | null
ai_error_log
string | null
ai_last_action
integer | null
created_at
string<date-time>
updated_at
string<date-time>
crm_task_type_id
string<uuid>
crm_task_stage_id
string<uuid>
crm_lead_id
string<uuid> | null
crm_deal_id
string<uuid> | null
crm_delivery_id
string<uuid> | null
crm_person_id
string<uuid> | null
crm_organization_id
string<uuid> | null
crm_customer_id
string<uuid> | null
recurrence_series_id
string<uuid> | null
recurrence_index
integer | null
recurrence_is_exception
boolean
is_recurring
boolean
recurrence
object | null
responsible_id
string<uuid> | null
created_by
object | null
completed_by
object | null
responsible
object | null
crm_task_type
object
crm_task_stage
object
crm_lead
object | null
crm_deal
object | null
crm_delivery
object | null
crm_person
object | null
crm_organization
object | null
crm_customer
object | null
mentions
object[]
recordings
object[]
reminders_minutes
integer[]
meeting_participants
string<email>[]
meeting_provider
enum<string> | null

Provedor de reunião online usado pela tarefa.

Available options:
teams_integration,
google_calendar_integration
provider
enum<string> | null

Provedor de reunião online usado pela tarefa.

Available options:
teams_integration,
google_calendar_integration
sync_warning
string
origin
enum<string>
Available options:
WEGLY,
GOOGLE_CALENDAR_IMPORT,
MICROSOFT_TEAMS_IMPORT
is_actionable
boolean
ai_generated
boolean
parent_task_id
string<uuid> | null
hierarchy_level
integer
is_subtask
boolean
parent_task
object | null
subtasks
array

Presente na listagem hierarchy_mode=grouped.

tags
object[]
calendar_lifecycle_status
enum<string> | null

Estado temporal de evento importado; null para tarefas nativas.

Available options:
upcoming,
in_progress,
ended,
cancelled,
unknown
meeting_mode
enum<string> | null
Available options:
online,
in_person
meeting_location
string | null
meeting_description
string | null
meeting_event
object | null
meeting_sync
object | null
meeting_attendees
object[]
meeting_can_manage_participants
boolean
calendar_event_url
string
meeting_response
object

Elegibilidade do ator para responder ao convite, retornada na consulta por ID.

meeting_can_respond
boolean
meeting_self_attendee_email
string | null
meeting_self_response_status
string | null
meeting_recorder_sessions
object[]

Sessões de gravação e seus artefatos disponíveis.

comments
object[]

Comentários incluídos na consulta de detalhes e nos retornos de escrita.