Create follow-up

Contacts API · contacts.follow_ups.create

URL · Fields · Example · Response · Try it

URL and authentication

POST https://YOUR-BACKEND/api/automation/v1/execute

Send Authorization: Bearer <connection key>, Accept: application/json and Content-Type: application/json. Create a connection.

This operation requires write access and CRM permission add_contact_followups. The gateway invokes POST /api/v1/app/lead-contact/{entity_id}/follow-ups internally. Use the POST URL above with your automation key, including for read and delete operations.

Request parameters

Key	Type	Requirement
`operation`	string	Required; exactly `contacts.follow_ups.create`
`parameters.entity_id`	integer	Required; positive parent record ID from your CRM
`data`	object	Required; see fields below
`idempotency_key`	string	Required; 8–100 characters. Unique per action; keep unchanged for identical retries.

Fields

When send_reminder is yes, remind_time and remind_type are required. Supply an explicit timezone offset on follow_up_date. follow_up_end_date must be on or after follow_up_date.

Fields below belong inside data. Dot paths describe nested objects; * means each array item. nullable permits null and sometimes validates a supplied field. in: lists allowed values; min: and max: limit the value, length or item count. exists: and exists_in_company: require a valid record ID. Conditional rules such as required_if and required_with refer to other fields in the same payload. Use YYYY-MM-DD for date-only values and timestamps with timezone offsets for follow-ups.

Field	Type	Requirement	Format / validation
`follow_up_date`	string	Required	required; date
`follow_up_end_date`	string	Optional	nullable; date; after_or_equal:follow_up_date
`remark`	string	Optional	nullable; string
`send_reminder`	string	Optional	nullable; string; in:yes,no
`remind_time`	number	Conditional	nullable; required_if:send_reminder,yes; numeric
`remind_type`	string	Conditional	nullable; required_if:send_reminder,yes; string; in:minute,hour,day
`type`	string	Optional	nullable; in:call,meeting,viewing,task,email,whatsapp
`status`	string	Optional	nullable; in:pending,completed,rescheduled,cancelled,no_show,needs_review
`result`	string	Optional	nullable; string
`listing_ids`	array	Optional	nullable; array
`listing_ids.*`	integer	Optional	integer; exists:listings,id
`was_backfilled`	boolean	Optional	nullable; boolean

Example request

Replace the example IDs and values with records in your installation. Supply any additional custom fields required by your company.

{
  "operation": "contacts.follow_ups.create",
  "parameters": {
    "entity_id": 1
  },
  "data": {
    "type": "call",
    "follow_up_date": "2026-11-01T10:00:00+04:00",
    "remark": "Discuss viewing options",
    "send_reminder": "no"
  },
  "idempotency_key": "example-event-12345"
}

Response

Returns the created follow-up in data. Use data.id for subsequent requests. Related fields depend on the resource and your permissions.

The gateway preserves the underlying HTTP status and JSON body. Successful requests return HTTP 200. A response may also include localized message fields.

Illustrative response excerpt (additional fields may be returned):

{
  "status": "success",
  "data": {
    "id": 456,
    "type": "call",
    "status": "pending"
  }
}

Errors

HTTP status	Meaning
400	A CRM business rule rejected the action.
401	Missing, invalid, expired or revoked connection key.
403	Connection access or CRM permissions do not allow this action.
404	Operation or record unavailable.
409	This idempotency key was already used with a different request.
413	Request or result exceeds its size limit; reduce payload or page size.
422	Missing or invalid fields, or a CRM business rule rejected the operation.
429	Rate limit exceeded; wait before retrying.
500	The server could not complete the operation.

Validation failures may return message / errors, or an error string with an optional fields array. The tester shows the actual HTTP status and full body. Read about limits and retries.

Try it

Brixit API v1

Try this request

contacts.follow_ups.create

Requests run from your browser to your installation. Enter the backend URL shown in Brixit. Your connection key stays in this component’s memory and is cleared when you leave this page.

Backend URLConnection key

CRM permission: add_contact_followups. Underlying route: POST /api/v1/app/lead-contact/{entity_id}/follow-ups. Send this operation to POST /execute.

parameters.entity_id Required · positive integer

Data (JSON object)

Example IDs are placeholders. Use your own record and lookup IDs. Required custom fields depend on your installation.

Idempotency keyUnique per action. Preserve this value and the payload when retrying.

POST /api/automation/v1/execute

Accept: application/json
Authorization: Bearer <connection key>
Content-Type: application/json

I reviewed this request and want to change real CRM data on the backend above. CRM notifications and automations may run.

Request format

entity_id must be a positive integer record ID.

Code uses a connection-key variable; your entered key is never included in copied examples.