Create a contact and add to automation

Request

Create a new contact and immediately add them to an automation. The contact is created in the specified list and starts the automation sequence. If skip_if_lead_exists is true, existing contacts won't be added again.

Security

bearerAuth

Path

flowUuidstringrequired

Automation UUID.

Bodyapplication/jsonrequired

leadobject(create-lead-fields)required

custom_fieldsobject

Custom field values.

Example:

{
  "field_position": "CTO"
}

list_uuidstringrequired

List UUID for the new contact.

update_lead_if_existsboolean

Default:true

move_to_listboolean

Default:false

flow_segment_idinteger

Automation segment to enter.

Default:1

skip_if_lead_existsboolean

Skip if contact already exists.

POST

/flows/api/flows/{flowUuid}/add-new-lead

curl -i -X POST \
  'https://leadgen.grinfi.io/flows/api/flows/{flowUuid}/add-new-lead' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "lead": {
      "linkedin_id": "john-doe-123456",
      "first_name": "John",
      "last_name": "Doe",
      "company_name": "Acme Inc"
    },
    "list_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "skip_if_lead_exists": true
  }'

Responses

Contact skipped (already exists).

Bodyapplication/json

reasonstring

Example:"skipped"

Response

{
  "reason": "skipped"
}