Ontraport

App · 24 actions

Keep Ontraport, the CRM and marketing automation platform, in step with the rest of your business: add and update contacts from sign-ups, tag them, start them on automations, give your team tasks, track deals and log sales. Start a workflow when a contact is added or tagged, a form is filled in, a deal moves or a sale is made.

Actions

ActionWhat it does
Add contact to automationStart a contact on automations or sequences, which then send their emails and run their steps.
Add noteAdd a note to a contact's record.
Add tags to contactTag a contact.
Complete taskMark a task done, with an outcome such as 'Signed' if you like.
Create contactAdd a contact to Ontraport, with tags if you like.
Create dealAdd a deal to your pipeline, with its value, stage and primary contact.
Create or update contactUpdate the contact with this email, or add one if nobody has it, such as for a form or sign-up.
Create productAdd a product, to sell on Ontraport's order forms or log sales of.
Create taskGive a user a task about a contact.
Delete recordDelete a contact, deal, product or task message for good.
Find contact by emailLook up the contact with an email.
Get contactGet a contact's details, including your custom fields.
List contactsList contacts matching every filter you give: words to search for, a tag, an owner, a field's value, or when they were added or changed.
List dealsList deals, newest first, by words in them, stage, primary contact or owner.
List formsList your forms, with how many times each was filled in.
List productsList your products, newest first.
List tasksList tasks, newest first: a contact's, those in a status, or a user's.
List transactionsList transactions (invoices), newest first: a contact's, those in a status, or those made after a time.
Log transactionRecord a sale of a product that was paid somewhere else, such as in another shop.
Remove contact from automationTake a contact out of automations or sequences, so they stop running for them.
Remove tags from contactTake tags off a contact, picked from your account or typed by name.
Update contactChange a contact's details.
Update dealChange a deal, such as moving it to another stage.
Update taskReassign a task, change when it's due, or cancel it.

Add contact to automation

Start a contact on automations or sequences, which then send their emails and run their steps. Pick at least one.

Inputs

ContactcontacttextRequired
The contact's ID, such as 27, from another Ontraport step or the trigger.
Automationsautomationslist
Automations from your account, picked from the list or by their ID.
Sequencessequenceslist
Sequences, the older kind of automation, if your account has any.

Outputs

automation_idslist
The IDs of the automations
contact_idtext
The contact's ID
messagetext
What Ontraport said, such as 'The subscription is now being processed.'
sequence_idslist
The IDs of the sequences
Example output
{
  "automation_ids": [
    "3"
  ],
  "contact_id": "27",
  "message": "The subscription is now being processed.",
  "sequence_ids": []
}

Add note

Add a note to a contact's record.

Inputs

ContactcontacttextRequired
The contact's ID, such as 27, from another Ontraport step or the trigger.
NotenotetextRequired
What the note says.

Outputs

contact_idtext
The ID of the contact it's on
idtext
The note's ID
notetext
What the note says
Example output
{
  "contact_id": "27",
  "id": "5",
  "note": "Called about the renewal; follow up next week."
}

Add tags to contact

Tag a contact. Pick tags from your account or type names; a new name makes the tag. Ontraport applies tags within a moment.

Inputs

ContactcontacttextRequired
The contact's ID, such as 27, from another Ontraport step or the trigger.
TagstagslistRequired
Pick tags, or type a tag's name; a name that's new makes the tag.

Outputs

contact_idtext
The contact's ID
messagetext
What Ontraport said, such as 'The tag is now being processed.'
tag_idslist
The IDs of the tags picked from the list
tag_nameslist
The tag names typed in
Example output
{
  "contact_id": "27",
  "message": "The tag is now being processed.",
  "tag_ids": [
    "2"
  ],
  "tag_names": [
    "Webinar attendee"
  ]
}

Complete task

Mark a task done, with an outcome such as 'Signed' if you like.

Inputs

TasktasktextRequired
The task's ID, such as 27, from another Ontraport step or the trigger.
Outcomeoutcometext
How it went, such as Signed. Ontraport adds it to its outcomes.

Outputs

assigned_attext
When it was assigned (ISO 8601)
assignee_idtext
The ID of the user it's assigned to
completed_attext
When it was completed (ISO 8601); empty if not yet
contact_idtext
The ID of the contact it's about
detailstext
The task's instructions
due_attext
When it's due (ISO 8601)
idtext
The task's ID; empty if Ontraport hasn't listed it yet
statustext
pending, complete or canceled
subjecttext
What the task is
task_message_idtext
The ID of the task message it was made from
Example output
{
  "assigned_at": "2017-04-11T16:44:10Z",
  "assignee_id": "1",
  "completed_at": "2018-03-29T16:44:10Z",
  "contact_id": "32",
  "details": "Fred, please complete this task.",
  "due_at": "2018-03-29T16:44:10Z",
  "id": "1",
  "status": "complete",
  "subject": "Do this.",
  "task_message_id": "7"
}

Create contact

Add a contact to Ontraport, with tags if you like. Ontraport allows two contacts with one email; use 'Create or update contact' for sign-ups.

Inputs

First namefirst_nametext
Their first name.
Last namelast_nametext
Their last name.
Emailemailtext
Their email.
Phonephonetext
Their office phone, such as +1 805 555 5555.
Mobile phonemobile_phonetext
Their mobile phone.
SMS numbersms_numbertext
The number they get texts at, with its country code.
Companycompanytext
Their company.
Job titlejob_titletext
Their job title.
Websitewebsitetext
Their website.
Addressaddresstext
Their street address.
Address line 2address2text
A suite or unit number.
Citycitytext
Their city.
Statestatetext
Their state or region as a code, such as CA.
ZIP or postal codeziptext
Their ZIP or postal code.
Countrycountrytext
Their country as a two-letter code, such as US.
Birthdaybirthdaydate
Their birthday.
Ownerownertext
The user who owns the record, or their ID.
Tagstagslist
Pick tags, or type a tag's name; a name that's new makes the tag.
Custom fieldscustom_fieldsobject
Fields your account added to contacts, by the name Ontraport shows, such as {"Lead score": 10}. A list field takes a list of its choices.

Outputs

addresstext
Their street address
address2text
The second line of their address
birthdaytext
Their birthday (YYYY-MM-DD); empty if unknown
citytext
Their city
companytext
Their company
countrytext
Their country, as a two-letter code such as US
created_attext
When they were added (ISO 8601)
custom_fieldsobject
Fields your account added, by the name Ontraport shows (a list field's choices as a list)
emailtext
Their email
email_statustext
Whether they get bulk email: Opted in, Double opt-in, Transactional only, Hard bounce or Under review
first_nametext
Their first name
idtext
The contact's ID
job_titletext
Their job title
last_activity_attext
When they last filled in a form, visited your site or clicked an email (ISO 8601)
last_nametext
Their last name
mobile_phonetext
Their mobile phone
nametext
Their full name
ordersnumber
How many orders they have placed
owner_idtext
The ID of the user who owns the contact
phonetext
Their office phone
scorenumber
Their lead score
sms_numbertext
The number they get texts at
sms_statustext
Whether they get bulk texts, such as Opted in or Unsubscribed
statetext
Their state or region, as a code such as CA
total_spentnumber
How much they have spent with you
unique_idtext
Ontraport's unique code for the contact, such as D4GD000
updated_attext
When their record last changed (ISO 8601)
websitetext
Their website
ziptext
Their ZIP or postal code
Example output
{
  "address": "2040 Alameda Padre Serra",
  "address2": "Suite 220",
  "birthday": "1984-11-17",
  "city": "Santa Barbara",
  "company": "Ontraport",
  "country": "US",
  "created_at": "2018-07-11T23:45:01Z",
  "custom_fields": {},
  "email": "user@ontraport.com",
  "email_status": "Opted in",
  "first_name": "First",
  "id": "27",
  "job_title": "Employee",
  "last_activity_at": "2018-07-11T23:45:01Z",
  "last_name": "Last",
  "mobile_phone": "",
  "name": "First Last",
  "orders": 0,
  "owner_id": "1",
  "phone": "805-555-5555",
  "score": 0.0,
  "sms_number": "+18055555555",
  "sms_status": "One to one only",
  "state": "CA",
  "total_spent": 0.0,
  "unique_id": "D4GD000",
  "updated_at": "2018-07-11T23:45:17Z",
  "website": "www.ontraport.com",
  "zip": "93103"
}

Create deal

Add a deal to your pipeline, with its value, stage and primary contact.

Inputs

NamenametextRequired
What the deal is called.
Valuevaluenumber
How much it's worth, such as 4800.At least 0.
Stagestagetext
The deal's stage, picked from your pipeline or typed by name.
Expected close dateexpected_close_datedate
When it should close.
Chance of winningwin_percentnumber
The expected chance of winning it, in percent.From 0 to 100.
Primary contactcontacttext
The contact's ID, such as 27, from another Ontraport step or the trigger.
Ownerownertext
The user who owns the record, or their ID.
Custom fieldscustom_fieldsobject
Fields your account added to deals, by the name Ontraport shows, such as {"Lead source": "Webinar"}. A list field takes a list of its choices.

Outputs

contact_idtext
The ID of its primary contact
created_attext
When it was added (ISO 8601)
custom_fieldsobject
Fields your account added, by the name Ontraport shows (a list field's choices as a list)
expected_close_datetext
When it's expected to close (YYYY-MM-DD)
idtext
The deal's ID
nametext
What the deal is called
owner_idtext
The ID of the user who owns it
stagetext
Its stage, as Ontraport shows it
stage_idtext
The ID of its stage
updated_attext
When it last changed (ISO 8601)
valuenumber
How much it's worth
win_percentnumber
The expected chance of winning it, from 0 to 100
Example output
{
  "contact_id": "27",
  "created_at": "2026-11-05T09:00:00Z",
  "custom_fields": {},
  "expected_close_date": "2026-12-15",
  "id": "12",
  "name": "Annual coaching package",
  "owner_id": "1",
  "stage": "Committed",
  "stage_id": "3",
  "updated_at": "2026-11-05T09:00:00Z",
  "value": 4800.0,
  "win_percent": 60.0
}

Create or update contact

Update the contact with this email, or add one if nobody has it, such as for a form or sign-up. Fields left blank keep what they have.

Inputs

EmailemailtextRequired
The email to match the contact on; they're added if nobody has it.
First namefirst_nametext
Their first name.
Last namelast_nametext
Their last name.
Phonephonetext
Their office phone, such as +1 805 555 5555.
Mobile phonemobile_phonetext
Their mobile phone.
SMS numbersms_numbertext
The number they get texts at, with its country code.
Companycompanytext
Their company.
Job titlejob_titletext
Their job title.
Websitewebsitetext
Their website.
Addressaddresstext
Their street address.
Address line 2address2text
A suite or unit number.
Citycitytext
Their city.
Statestatetext
Their state or region as a code, such as CA.
ZIP or postal codeziptext
Their ZIP or postal code.
Countrycountrytext
Their country as a two-letter code, such as US.
Birthdaybirthdaydate
Their birthday.
Ownerownertext
The user who owns the record, or their ID.
Tagstagslist
Pick tags, or type a tag's name; a name that's new makes the tag.
Custom fieldscustom_fieldsobject
Fields your account added to contacts, by the name Ontraport shows, such as {"Lead score": 10}. A list field takes a list of its choices.

Outputs

addresstext
Their street address
address2text
The second line of their address
birthdaytext
Their birthday (YYYY-MM-DD); empty if unknown
citytext
Their city
companytext
Their company
countrytext
Their country, as a two-letter code such as US
createdtrue/false
True if the contact was added, false if one was updated
created_attext
When they were added (ISO 8601)
custom_fieldsobject
Fields your account added, by the name Ontraport shows (a list field's choices as a list)
emailtext
Their email
email_statustext
Whether they get bulk email: Opted in, Double opt-in, Transactional only, Hard bounce or Under review
first_nametext
Their first name
idtext
The contact's ID
job_titletext
Their job title
last_activity_attext
When they last filled in a form, visited your site or clicked an email (ISO 8601)
last_nametext
Their last name
mobile_phonetext
Their mobile phone
nametext
Their full name
ordersnumber
How many orders they have placed
owner_idtext
The ID of the user who owns the contact
phonetext
Their office phone
scorenumber
Their lead score
sms_numbertext
The number they get texts at
sms_statustext
Whether they get bulk texts, such as Opted in or Unsubscribed
statetext
Their state or region, as a code such as CA
total_spentnumber
How much they have spent with you
unique_idtext
Ontraport's unique code for the contact, such as D4GD000
updated_attext
When their record last changed (ISO 8601)
websitetext
Their website
ziptext
Their ZIP or postal code
Example output
{
  "address": "2040 Alameda Padre Serra",
  "address2": "Suite 220",
  "birthday": "1984-11-17",
  "city": "Santa Barbara",
  "company": "Ontraport",
  "country": "US",
  "created": true,
  "created_at": "2018-07-11T23:45:01Z",
  "custom_fields": {},
  "email": "user@ontraport.com",
  "email_status": "Opted in",
  "first_name": "First",
  "id": "27",
  "job_title": "Employee",
  "last_activity_at": "2018-07-11T23:45:01Z",
  "last_name": "Last",
  "mobile_phone": "",
  "name": "First Last",
  "orders": 0,
  "owner_id": "1",
  "phone": "805-555-5555",
  "score": 0.0,
  "sms_number": "+18055555555",
  "sms_status": "One to one only",
  "state": "CA",
  "total_spent": 0.0,
  "unique_id": "D4GD000",
  "updated_at": "2018-07-11T23:45:17Z",
  "website": "www.ontraport.com",
  "zip": "93103"
}

Create product

Add a product, to sell on Ontraport's order forms or log sales of.

Inputs

NamenametextRequired
What the product is called.
PricepricenumberRequired
What one costs, such as 49.99.At least 0.

Outputs

created_attext
When it was added (ISO 8601)
descriptiontext
Its description
idtext
The product's ID
nametext
Its name
pricenumber
Its price
skutext
Its SKU
total_incomenumber
How much it has earned
total_purchasesnumber
How many times it has been bought
updated_attext
When it last changed (ISO 8601)
Example output
{
  "created_at": "2018-08-06T20:35:32Z",
  "description": "",
  "id": "1",
  "name": "cheesecake",
  "price": 2.99,
  "sku": "",
  "total_income": 630.0,
  "total_purchases": 73,
  "updated_at": "2018-08-06T20:35:32Z"
}

Create task

Give a user a task about a contact. Pick one of your task messages, or write a subject and details, which Ontraport keeps as a task message of their own.

Inputs

ContactcontacttextRequired
The contact's ID, such as 27, from another Ontraport step or the trigger.
Subjectsubjecttext
What needs doing. Needed unless you pick a task message.
Detailsdetailstext
More about it. You can use merge fields such as [First Name].
Task messagetask_messagetext
One of your task messages to use instead of a subject and details.
Due datedue_datedate
When it's due. Left blank, it's due today, or when the task message says.
Assigned toassigneetext
The user who does the task, or their ID.

Outputs

assigned_attext
When it was assigned (ISO 8601)
assignee_idtext
The ID of the user it's assigned to
completed_attext
When it was completed (ISO 8601); empty if not yet
contact_idtext
The ID of the contact it's about
detailstext
The task's instructions
due_attext
When it's due (ISO 8601)
idtext
The task's ID; empty if Ontraport hasn't listed it yet
statustext
pending, complete or canceled
subjecttext
What the task is
task_message_createdtrue/false
True if a task message was made for this task's subject
task_message_idtext
The ID of the task message it was made from
Example output
{
  "assigned_at": "2017-04-11T16:44:10Z",
  "assignee_id": "1",
  "completed_at": "",
  "contact_id": "32",
  "details": "Fred, please complete this task.",
  "due_at": "2018-03-29T16:44:10Z",
  "id": "1",
  "status": "pending",
  "subject": "Do this.",
  "task_message_created": true,
  "task_message_id": "7"
}

Delete record

Delete a contact, deal, product or task message for good. Ontraport can't undo it.

Inputs

Typerecord_typetextRequired
What kind of record it is.One of: contact, deal, product, task_message (Task message).
RecordrecordtextRequired
Its ID, such as 27, from another Ontraport step or the trigger.

Outputs

deletedtrue/false
True once it's deleted
idtext
The ID of what was deleted
record_typetext
contact, deal, product or task_message
Example output
{
  "deleted": true,
  "id": "27",
  "record_type": "contact"
}

Find contact by email

Look up the contact with an email. If several have it, the newest is given; 'Found' says whether anyone has it.

Inputs

EmailemailtextRequired
The email to look for.

Outputs

addresstext
Their street address
address2text
The second line of their address
birthdaytext
Their birthday (YYYY-MM-DD); empty if unknown
citytext
Their city
companytext
Their company
countrytext
Their country, as a two-letter code such as US
created_attext
When they were added (ISO 8601)
custom_fieldsobject
Fields your account added, by the name Ontraport shows (a list field's choices as a list)
emailtext
Their email
email_statustext
Whether they get bulk email: Opted in, Double opt-in, Transactional only, Hard bounce or Under review
first_nametext
Their first name
foundtrue/false
Whether any contact has that email
idtext
The contact's ID
job_titletext
Their job title
last_activity_attext
When they last filled in a form, visited your site or clicked an email (ISO 8601)
last_nametext
Their last name
matchesnumber
How many contacts have that email
mobile_phonetext
Their mobile phone
nametext
Their full name
ordersnumber
How many orders they have placed
owner_idtext
The ID of the user who owns the contact
phonetext
Their office phone
scorenumber
Their lead score
sms_numbertext
The number they get texts at
sms_statustext
Whether they get bulk texts, such as Opted in or Unsubscribed
statetext
Their state or region, as a code such as CA
total_spentnumber
How much they have spent with you
unique_idtext
Ontraport's unique code for the contact, such as D4GD000
updated_attext
When their record last changed (ISO 8601)
websitetext
Their website
ziptext
Their ZIP or postal code
Example output
{
  "address": "2040 Alameda Padre Serra",
  "address2": "Suite 220",
  "birthday": "1984-11-17",
  "city": "Santa Barbara",
  "company": "Ontraport",
  "country": "US",
  "created_at": "2018-07-11T23:45:01Z",
  "custom_fields": {},
  "email": "user@ontraport.com",
  "email_status": "Opted in",
  "first_name": "First",
  "found": true,
  "id": "27",
  "job_title": "Employee",
  "last_activity_at": "2018-07-11T23:45:01Z",
  "last_name": "Last",
  "matches": 1,
  "mobile_phone": "",
  "name": "First Last",
  "orders": 0,
  "owner_id": "1",
  "phone": "805-555-5555",
  "score": 0.0,
  "sms_number": "+18055555555",
  "sms_status": "One to one only",
  "state": "CA",
  "total_spent": 0.0,
  "unique_id": "D4GD000",
  "updated_at": "2018-07-11T23:45:17Z",
  "website": "www.ontraport.com",
  "zip": "93103"
}

Get contact

Get a contact's details, including your custom fields.

Inputs

ContactcontacttextRequired
The contact's ID, such as 27, from another Ontraport step or the trigger.

Outputs

addresstext
Their street address
address2text
The second line of their address
birthdaytext
Their birthday (YYYY-MM-DD); empty if unknown
citytext
Their city
companytext
Their company
countrytext
Their country, as a two-letter code such as US
created_attext
When they were added (ISO 8601)
custom_fieldsobject
Fields your account added, by the name Ontraport shows (a list field's choices as a list)
emailtext
Their email
email_statustext
Whether they get bulk email: Opted in, Double opt-in, Transactional only, Hard bounce or Under review
first_nametext
Their first name
idtext
The contact's ID
job_titletext
Their job title
last_activity_attext
When they last filled in a form, visited your site or clicked an email (ISO 8601)
last_nametext
Their last name
mobile_phonetext
Their mobile phone
nametext
Their full name
ordersnumber
How many orders they have placed
owner_idtext
The ID of the user who owns the contact
phonetext
Their office phone
scorenumber
Their lead score
sms_numbertext
The number they get texts at
sms_statustext
Whether they get bulk texts, such as Opted in or Unsubscribed
statetext
Their state or region, as a code such as CA
total_spentnumber
How much they have spent with you
unique_idtext
Ontraport's unique code for the contact, such as D4GD000
updated_attext
When their record last changed (ISO 8601)
websitetext
Their website
ziptext
Their ZIP or postal code
Example output
{
  "address": "2040 Alameda Padre Serra",
  "address2": "Suite 220",
  "birthday": "1984-11-17",
  "city": "Santa Barbara",
  "company": "Ontraport",
  "country": "US",
  "created_at": "2018-07-11T23:45:01Z",
  "custom_fields": {},
  "email": "user@ontraport.com",
  "email_status": "Opted in",
  "first_name": "First",
  "id": "27",
  "job_title": "Employee",
  "last_activity_at": "2018-07-11T23:45:01Z",
  "last_name": "Last",
  "mobile_phone": "",
  "name": "First Last",
  "orders": 0,
  "owner_id": "1",
  "phone": "805-555-5555",
  "score": 0.0,
  "sms_number": "+18055555555",
  "sms_status": "One to one only",
  "state": "CA",
  "total_spent": 0.0,
  "unique_id": "D4GD000",
  "updated_at": "2018-07-11T23:45:17Z",
  "website": "www.ontraport.com",
  "zip": "93103"
}

List contacts

List contacts matching every filter you give: words to search for, a tag, an owner, a field's value, or when they were added or changed. Leave every filter blank to list the newest.

Inputs

Searchsearchtext
Words to look for, such as a name or email.
Tagtagtext
Only contacts with this tag.
Ownerownertext
Only contacts this user owns.
Fieldfieldtext
Only contacts whose field has the value below. Pick the field.
Field valuefield_valuetext
The value the field must have; a dropdown field's choice by name.
Added aftercreated_afterdate and time
Only contacts added after this.
Changed afterupdated_afterdate and time
Only contacts changed after this.
Ordersorttext
The order to list them in.One of: newest (Newest first), recently_updated (Recently changed first), last_name (Last name, A to Z). Default: newest.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 200.

Outputs

contactslist
The contacts found
countnumber
How many are listed
Example output
{
  "contacts": [
    {
      "address": "2040 Alameda Padre Serra",
      "address2": "Suite 220",
      "birthday": "1984-11-17",
      "city": "Santa Barbara",
      "company": "Ontraport",
      "country": "US",
      "created_at": "2018-07-11T23:45:01Z",
      "custom_fields": {},
      "email": "user@ontraport.com",
      "email_status": "Opted in",
      "first_name": "First",
      "id": "27",
      "job_title": "Employee",
      "last_activity_at": "2018-07-11T23:45:01Z",
      "last_name": "Last",
      "mobile_phone": "",
      "name": "First Last",
      "orders": 0,
      "owner_id": "1",
      "phone": "805-555-5555",
      "score": 0.0,
      "sms_number": "+18055555555",
      "sms_status": "One to one only",
      "state": "CA",
      "total_spent": 0.0,
      "unique_id": "D4GD000",
      "updated_at": "2018-07-11T23:45:17Z",
      "website": "www.ontraport.com",
      "zip": "93103"
    }
  ],
  "count": 1
}

List deals

List deals, newest first, by words in them, stage, primary contact or owner.

Inputs

Searchsearchtext
Words to look for in the deal.
Stagestagetext
Only deals in this stage.
Primary contactcontacttext
The contact's ID, such as 27, from another Ontraport step or the trigger.
Ownerownertext
Only deals this user owns.
How manylimitnumber
The most to list, newest first. Defaults to 25.From 1 to 200.

Outputs

countnumber
How many are listed
dealslist
The deals found
Example output
{
  "count": 1,
  "deals": [
    {
      "contact_id": "27",
      "created_at": "2026-11-05T09:00:00Z",
      "custom_fields": {},
      "expected_close_date": "2026-12-15",
      "id": "12",
      "name": "Annual coaching package",
      "owner_id": "1",
      "stage": "Committed",
      "stage_id": "3",
      "updated_at": "2026-11-05T09:00:00Z",
      "value": 4800.0,
      "win_percent": 60.0
    }
  ]
}

List forms

List your forms, with how many times each was filled in.

Inputs

Searchsearchtext
Words to look for in the name.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 50.

Outputs

countnumber
How many are listed
formslist
The forms found
Example output
{
  "count": 1,
  "forms": [
    {
      "created_at": "2017-11-14T23:55:43Z",
      "id": "2",
      "name": "Test Form",
      "submissions": 0,
      "thank_you_page": "",
      "type": "ONTRAform",
      "unique_visits": 0,
      "updated_at": "2017-11-14T23:55:43Z",
      "visits": 0
    }
  ]
}

List products

List your products, newest first.

Inputs

Searchsearchtext
Words to look for in the name.
How manylimitnumber
The most to list, newest first. Defaults to 25.From 1 to 200.

Outputs

countnumber
How many are listed
productslist
The products found
Example output
{
  "count": 1,
  "products": [
    {
      "created_at": "2018-08-06T20:35:32Z",
      "description": "",
      "id": "1",
      "name": "cheesecake",
      "price": 2.99,
      "sku": "",
      "total_income": 630.0,
      "total_purchases": 73,
      "updated_at": "2018-08-06T20:35:32Z"
    }
  ]
}

List tasks

List tasks, newest first: a contact's, those in a status, or a user's.

Inputs

Contactcontacttext
The contact's ID, such as 27, from another Ontraport step or the trigger.
Statusstatustext
Only tasks in this status.One of: pending, complete, canceled.
Assigned toassigneetext
Only tasks this user does.
How manylimitnumber
The most to list, newest first. Defaults to 25.From 1 to 200.

Outputs

countnumber
How many are listed
taskslist
The tasks found
Example output
{
  "count": 1,
  "tasks": [
    {
      "assigned_at": "2017-04-11T16:44:10Z",
      "assignee_id": "1",
      "completed_at": "",
      "contact_id": "32",
      "details": "Fred, please complete this task.",
      "due_at": "2018-03-29T16:44:10Z",
      "id": "1",
      "status": "pending",
      "subject": "Do this.",
      "task_message_id": "7"
    }
  ]
}

List transactions

List transactions (invoices), newest first: a contact's, those in a status, or those made after a time.

Inputs

Contactcontacttext
The contact's ID, such as 27, from another Ontraport step or the trigger.
Statusstatustext
Only transactions in this status.One of: paid, pending, unpaid, draft, collections, declined, refunded, partially_refunded (Partially refunded), voided, written_off (Written off), closed.
Made aftercreated_afterdate and time
Only transactions made after this.
How manylimitnumber
The most to list, newest first. Defaults to 25.From 1 to 200.

Outputs

countnumber
How many are listed
transactionslist
The transactions found
Example output
{
  "count": 1,
  "transactions": [
    {
      "contact_id": "1",
      "contact_name": "Mary Smith",
      "created_at": "2017-04-19T17:58:20Z",
      "external_order_id": "",
      "form_id": "0",
      "id": "1",
      "order_id": "0",
      "products": [
        {
          "id": "5",
          "name": "Lambas Bread",
          "price": 20.0,
          "quantity": 20,
          "total": 400.0
        }
      ],
      "shipping": 0.0,
      "status": "written_off",
      "subtotal": 400.0,
      "tax": 0.0,
      "total": 400.0
    }
  ]
}

Log transaction

Record a sale of a product that was paid somewhere else, such as in another shop. Nobody is charged, and no invoice is emailed unless you ask for one.

Inputs

ContactcontacttextRequired
The contact's ID, such as 27, from another Ontraport step or the trigger.
ProductproducttextRequired
The product sold, or its ID.
Quantityquantitynumber
How many were sold. Defaults to 1.At least 1.
Pricepricenumber
What one sold for. Leave blank for the product's price.At least 0.
Datetransaction_datedate and time
When it sold. Leave blank for now.
Email an invoicesend_invoicetrue/false
Email the contact Ontraport's invoice for it.Default: false.
Order numberexternal_order_idtext
The order's number in the other shop, kept on the transaction.

Outputs

contact_idtext
The ID of the contact who bought
contact_nametext
Their full name
created_attext
When it was made (ISO 8601)
external_order_idtext
The order's ID in another system, if given
form_idtext
The order form it came from; 0 if none
idtext
The transaction's (invoice's) ID
order_idtext
The subscription order it belongs to; 0 if none
productslist
What was bought
shippingnumber
The shipping
statustext
paid, pending, unpaid, draft, collections, declined, refunded, partially_refunded, voided, written_off or closed
subtotalnumber
The amount before tax and shipping
taxnumber
The tax
totalnumber
The total
Example output
{
  "contact_id": "1",
  "contact_name": "Mary Smith",
  "created_at": "2017-04-19T17:58:20Z",
  "external_order_id": "",
  "form_id": "0",
  "id": "1",
  "order_id": "0",
  "products": [
    {
      "id": "5",
      "name": "Lambas Bread",
      "price": 20.0,
      "quantity": 20,
      "total": 400.0
    }
  ],
  "shipping": 0.0,
  "status": "written_off",
  "subtotal": 400.0,
  "tax": 0.0,
  "total": 400.0
}

Remove contact from automation

Take a contact out of automations or sequences, so they stop running for them. Pick at least one.

Inputs

ContactcontacttextRequired
The contact's ID, such as 27, from another Ontraport step or the trigger.
Automationsautomationslist
Automations from your account, picked from the list or by their ID.
Sequencessequenceslist
Sequences, the older kind of automation, if your account has any.

Outputs

automation_idslist
The IDs of the automations
contact_idtext
The contact's ID
messagetext
What Ontraport said, such as 'The subscription is now being processed.'
sequence_idslist
The IDs of the sequences
Example output
{
  "automation_ids": [
    "3"
  ],
  "contact_id": "27",
  "message": "The subscription is now being processed.",
  "sequence_ids": []
}

Remove tags from contact

Take tags off a contact, picked from your account or typed by name. A tag the contact doesn't have is skipped.

Inputs

ContactcontacttextRequired
The contact's ID, such as 27, from another Ontraport step or the trigger.
TagstagslistRequired
Pick tags, or type a tag's name.

Outputs

contact_idtext
The contact's ID
messagetext
What Ontraport said, such as 'The tag is now being processed.'
tag_idslist
The IDs of the tags picked from the list
tag_nameslist
The tag names typed in
Example output
{
  "contact_id": "27",
  "message": "The tag is now being processed.",
  "tag_ids": [
    "2"
  ],
  "tag_names": [
    "Webinar attendee"
  ]
}

Update contact

Change a contact's details. Fields left blank keep what they have.

Inputs

ContactcontacttextRequired
The contact's ID, such as 27, from another Ontraport step or the trigger.
First namefirst_nametext
Their first name.
Last namelast_nametext
Their last name.
Emailemailtext
Their email.
Phonephonetext
Their office phone, such as +1 805 555 5555.
Mobile phonemobile_phonetext
Their mobile phone.
SMS numbersms_numbertext
The number they get texts at, with its country code.
Companycompanytext
Their company.
Job titlejob_titletext
Their job title.
Websitewebsitetext
Their website.
Addressaddresstext
Their street address.
Address line 2address2text
A suite or unit number.
Citycitytext
Their city.
Statestatetext
Their state or region as a code, such as CA.
ZIP or postal codeziptext
Their ZIP or postal code.
Countrycountrytext
Their country as a two-letter code, such as US.
Birthdaybirthdaydate
Their birthday.
Ownerownertext
The user who owns the record, or their ID.
Custom fieldscustom_fieldsobject
Fields your account added to contacts, by the name Ontraport shows, such as {"Lead score": 10}. A list field takes a list of its choices.

Outputs

addresstext
Their street address
address2text
The second line of their address
birthdaytext
Their birthday (YYYY-MM-DD); empty if unknown
citytext
Their city
companytext
Their company
countrytext
Their country, as a two-letter code such as US
created_attext
When they were added (ISO 8601)
custom_fieldsobject
Fields your account added, by the name Ontraport shows (a list field's choices as a list)
emailtext
Their email
email_statustext
Whether they get bulk email: Opted in, Double opt-in, Transactional only, Hard bounce or Under review
first_nametext
Their first name
idtext
The contact's ID
job_titletext
Their job title
last_activity_attext
When they last filled in a form, visited your site or clicked an email (ISO 8601)
last_nametext
Their last name
mobile_phonetext
Their mobile phone
nametext
Their full name
ordersnumber
How many orders they have placed
owner_idtext
The ID of the user who owns the contact
phonetext
Their office phone
scorenumber
Their lead score
sms_numbertext
The number they get texts at
sms_statustext
Whether they get bulk texts, such as Opted in or Unsubscribed
statetext
Their state or region, as a code such as CA
total_spentnumber
How much they have spent with you
unique_idtext
Ontraport's unique code for the contact, such as D4GD000
updated_attext
When their record last changed (ISO 8601)
websitetext
Their website
ziptext
Their ZIP or postal code
Example output
{
  "address": "2040 Alameda Padre Serra",
  "address2": "Suite 220",
  "birthday": "1984-11-17",
  "city": "Santa Barbara",
  "company": "Ontraport",
  "country": "US",
  "created_at": "2018-07-11T23:45:01Z",
  "custom_fields": {},
  "email": "user@ontraport.com",
  "email_status": "Opted in",
  "first_name": "First",
  "id": "27",
  "job_title": "Employee",
  "last_activity_at": "2018-07-11T23:45:01Z",
  "last_name": "Last",
  "mobile_phone": "",
  "name": "First Last",
  "orders": 0,
  "owner_id": "1",
  "phone": "805-555-5555",
  "score": 0.0,
  "sms_number": "+18055555555",
  "sms_status": "One to one only",
  "state": "CA",
  "total_spent": 0.0,
  "unique_id": "D4GD000",
  "updated_at": "2018-07-11T23:45:17Z",
  "website": "www.ontraport.com",
  "zip": "93103"
}

Update deal

Change a deal, such as moving it to another stage. Fields left blank keep what they have.

Inputs

DealdealtextRequired
The deal's ID, such as 27, from another Ontraport step or the trigger.
Namenametext
A new name. Leave blank to keep it.
Valuevaluenumber
How much it's worth, such as 4800.At least 0.
Stagestagetext
The deal's stage, picked from your pipeline or typed by name.
Expected close dateexpected_close_datedate
When it should close.
Chance of winningwin_percentnumber
The expected chance of winning it, in percent.From 0 to 100.
Primary contactcontacttext
The contact's ID, such as 27, from another Ontraport step or the trigger.
Ownerownertext
The user who owns the record, or their ID.
Custom fieldscustom_fieldsobject
Fields your account added to deals, by the name Ontraport shows, such as {"Lead source": "Webinar"}. A list field takes a list of its choices.

Outputs

contact_idtext
The ID of its primary contact
created_attext
When it was added (ISO 8601)
custom_fieldsobject
Fields your account added, by the name Ontraport shows (a list field's choices as a list)
expected_close_datetext
When it's expected to close (YYYY-MM-DD)
idtext
The deal's ID
nametext
What the deal is called
owner_idtext
The ID of the user who owns it
stagetext
Its stage, as Ontraport shows it
stage_idtext
The ID of its stage
updated_attext
When it last changed (ISO 8601)
valuenumber
How much it's worth
win_percentnumber
The expected chance of winning it, from 0 to 100
Example output
{
  "contact_id": "27",
  "created_at": "2026-11-05T09:00:00Z",
  "custom_fields": {},
  "expected_close_date": "2026-12-15",
  "id": "12",
  "name": "Annual coaching package",
  "owner_id": "1",
  "stage": "Committed",
  "stage_id": "3",
  "updated_at": "2026-11-05T09:00:00Z",
  "value": 4800.0,
  "win_percent": 60.0
}

Update task

Reassign a task, change when it's due, or cancel it. Fields left blank keep what they have; use 'Complete task' to finish one with an outcome.

Inputs

TasktasktextRequired
The task's ID, such as 27, from another Ontraport step or the trigger.
Assigned toassigneetext
The user who does the task, or their ID.
Duedue_atdate and time
When it's due.
Statusstatustext
Where it stands.One of: pending, complete, canceled.

Outputs

assigned_attext
When it was assigned (ISO 8601)
assignee_idtext
The ID of the user it's assigned to
completed_attext
When it was completed (ISO 8601); empty if not yet
contact_idtext
The ID of the contact it's about
detailstext
The task's instructions
due_attext
When it's due (ISO 8601)
idtext
The task's ID; empty if Ontraport hasn't listed it yet
statustext
pending, complete or canceled
subjecttext
What the task is
task_message_idtext
The ID of the task message it was made from
Example output
{
  "assigned_at": "2017-04-11T16:44:10Z",
  "assignee_id": "1",
  "completed_at": "",
  "contact_id": "32",
  "details": "Fred, please complete this task.",
  "due_at": "2018-03-29T16:44:10Z",
  "id": "1",
  "status": "pending",
  "subject": "Do this.",
  "task_message_id": "7"
}

On this page