Unify

App · 25 actions

Manage outbound records, lists, sequences, and follow-up tasks in Unify.

Actions

ActionWhat it does
Add list entriesAdd list entries.
Complete taskComplete task.
Create listCreate list.
Create object recordCreate object record.
Create taskCreate task.
Delete listDelete list.
Delete object recordDelete object record.
Delete taskDelete task.
Find unique object recordFind unique object record.
Get listGet list.
Get list entryGet list entry.
Get object recordGet object record.
Get sequenceGet sequence.
Get taskGet task.
List list entriesList list entries.
List listsList lists.
List object attributesList object attributes.
List objectsList objects.
List sequencesList sequences.
List tasksList tasks.
Remove list entriesRemove list entries.
Update listUpdate list.
Update object recordUpdate object record.
Update taskUpdate task.
Upsert object recordUpsert object record.

Add list entries

Add list entries.

Inputs

Listlist_idtextRequired
String UUIDv4 value.
RecordsrecordslistRequired
Up to 100 record identifiers to add, processed in request order. ID and match identifiers may be mixed. Duplicate identifiers are not allowed.

Outputs

dataobject
Response for adding records to a list.
Example output
{
  "data": {
    "data": [],
    "status": "success",
    "summary": {
      "added": 1,
      "already_in_list": 1,
      "object_mismatch": 1,
      "record_not_found": 1,
      "total": 1
    }
  }
}

Complete task

Complete task.

Inputs

IdidtextRequired
Id.

Outputs

dataobject
Unify response data.
Example output
{
  "data": {}
}

Create list

Create list.

Inputs

NamenametextRequired
Name of the list. Must be unique within the workspace.
ObjectobjecttextRequired
API name of the object whose records the list will hold. Cannot be changed after creation.
Share statusshare_statustext
Who can see and change the list. Defaults to `ONLY_ME`.One of: ONLY_ME (Only me), ALL_OTHERS_CAN_VIEW (All others can view), ALL_OTHERS_CAN_EDIT (All others can edit).

Outputs

dataobject
Response for a successful create operation.
Example output
{
  "data": {
    "data": {
      "created_at": "example",
      "id": "example",
      "name": "example",
      "object": "example",
      "owner_id": "example",
      "share_status": "ONLY_ME",
      "updated_at": "example"
    },
    "status": "success"
  }
}

Create object record

Create object record.

Inputs

Object nameobject_nametextRequired
The API name of an object, e.g. `company`, `person`, `opportunity`, or a custom object's API name.
Validation modevalidation_modetext
Validation mode for request data. - `strict`: Reject requests if any attribute is invalid or unrecognized. - `ignore_invalid`: Ignore unknown attributes and omit invalid values for optional attributes. Reject requests with an invalid body structure or invalid required attributes.One of: strict, ignore_invalid (Ignore invalid).
DatadataobjectRequired
The attribute values for the new record. All required attributes on the object must be included.

Outputs

dataobject
Response for a successful create operation.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "created_at": "example",
      "id": "example",
      "object": "example",
      "updated_at": "example"
    },
    "status": "success"
  }
}

Create task

Create task.

Inputs

Person idperson_idtextRequired
Person id.
Priorityprioritytext
Priority.One of: LOW, MEDIUM, HIGH, URGENT.
Due atdue_atdate and time
Due at.

Outputs

dataobject
Response for a successful create operation.
Example output
{
  "data": {
    "data": {
      "assigned_user_id": "example",
      "created_at": "example",
      "due_at": "example",
      "ended_at": "example",
      "id": "example",
      "note_content": "example",
      "person_id": "example",
      "priority": "LOW",
      "status": "NOT_READY",
      "type": "EMAIL",
      "updated_at": "example"
    },
    "status": "success"
  }
}

Delete list

Delete list.

Inputs

Listlist_idtextRequired
String UUIDv4 value.

Outputs

dataobject
Response for a successful delete operation.
Example output
{
  "data": {
    "status": "success"
  }
}

Delete object record

Delete object record.

Inputs

Object nameobject_nametextRequired
The API name of an object, e.g. `company`, `person`, `opportunity`, or a custom object's API name.
Record idrecord_idtextRequired
Record id.

Outputs

dataobject
Response for a successful delete operation.
Example output
{
  "data": {
    "status": "success"
  }
}

Delete task

Delete task.

Inputs

IdidtextRequired
Id.

Outputs

dataobject
Response for a successful delete operation.
Example output
{
  "data": {
    "status": "success"
  }
}

Find unique object record

Find unique object record.

Inputs

Object nameobject_nametextRequired
The API name of an object, e.g. `company`, `person`, `opportunity`, or a custom object's API name.
MatchmatchobjectRequired
Attribute values used to find an existing record. Include at least one unique attribute. Additional attributes narrow the match.

Outputs

dataobject
Response for a successful get operation.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "created_at": "example",
      "id": "example",
      "object": "example",
      "updated_at": "example"
    },
    "status": "success"
  }
}

Get list

Get list.

Inputs

Listlist_idtextRequired
String UUIDv4 value.

Outputs

dataobject
Response for a successful get operation.
Example output
{
  "data": {
    "data": {
      "created_at": "example",
      "id": "example",
      "name": "example",
      "object": "example",
      "owner_id": "example",
      "share_status": "ONLY_ME",
      "updated_at": "example"
    },
    "status": "success"
  }
}

Get list entry

Get list entry.

Inputs

Listlist_idtextRequired
String UUIDv4 value.
Entry identry_idtextRequired
String UUIDv4 value.

Outputs

dataobject
Response for a successful get operation.
Example output
{
  "data": {
    "data": {
      "created_at": "example",
      "id": "example",
      "list_id": "example",
      "object": "example",
      "record_id": "example",
      "updated_at": "example"
    },
    "status": "success"
  }
}

Get object record

Get object record.

Inputs

Object nameobject_nametextRequired
The API name of an object, e.g. `company`, `person`, `opportunity`, or a custom object's API name.
Record idrecord_idtextRequired
Record id.

Outputs

dataobject
Response for a successful get operation.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "created_at": "example",
      "id": "example",
      "object": "example",
      "updated_at": "example"
    },
    "status": "success"
  }
}

Get sequence

Get sequence.

Inputs

IdidtextRequired
String UUID value.

Outputs

dataobject
An automated series of outreach steps for enrolled people.
Example output
{
  "data": {
    "created_at": "example",
    "id": "example",
    "is_paused": false,
    "name": "example",
    "owner": {
      "email": "example",
      "first_name": "example",
      "id": "example",
      "last_name": "example"
    },
    "send_schedule": {
      "created_at": "example",
      "id": "example",
      "is_default": false,
      "name": "example",
      "rules": {
        "excluded_dates": [],
        "send_days": {
          "1": [],
          "2": [],
          "3": [],
          "4": [],
          "5": [],
          "6": [],
          "7": []
        },
        "skip_us_holidays": false,
        "time_zone": "example"
      },
      "updated_at": "example"
    },
    "sequence_ruleset": {
      "allow_same_sequence_reenrollment": false,
      "automatic_enrollment_task_assignment": "ASSIGN_TO_MAILBOX_OWNER",
      "automatic_enrollment_task_assignment_user_id": "example",
      "block_reenrollment_units": "MINUTE",
      "block_reenrollment_value": 1,
      "created_at": "example",
      "id": "example",
      "is_default": false,
      "manual_enrollment_task_assignment": "ASSIGN_TO_ENROLLER",
      "manual_enrollment_task_assignment_user_id": "example",
      "name": "example",
      "opt_out_message": "example",
      "updated_at": "example"
    },
    "updated_at": "example"
  }
}

Get task

Get task.

Inputs

IdidtextRequired
Id.

Outputs

dataobject
Response for a successful get operation.
Example output
{
  "data": {
    "data": {
      "assigned_user_id": "example",
      "created_at": "example",
      "due_at": "example",
      "ended_at": "example",
      "id": "example",
      "note_content": "example",
      "person_id": "example",
      "priority": "LOW",
      "status": "NOT_READY",
      "type": "EMAIL",
      "updated_at": "example"
    },
    "status": "success"
  }
}

List list entries

List list entries.

Inputs

Listlist_idtextRequired
String UUIDv4 value.
Cursorcursortext
String UUIDv4 value.
Limitlimitnumber
Maximum number of entries to return. Defaults to 100.From 1 to 100.

Outputs

dataobject
Response for a successful paginated list of entries.
Example output
{
  "data": {
    "data": [],
    "next_cursor": "example",
    "status": "success"
  }
}

List lists

List lists.

Inputs

Cursorcursortext
String UUIDv4 value.
Limitlimitnumber
Maximum number of lists to return. Defaults to 100.From 1 to 100.
Objectobjecttext
The API name of an object, e.g. `company`, `person`, `opportunity`, or a custom object's API name.
Namenametext
Filter lists by exact name.

Outputs

dataobject
Response for a successful paginated list of lists.
Example output
{
  "data": {
    "data": [],
    "next_cursor": "example",
    "status": "success"
  }
}

List object attributes

List object attributes.

Inputs

Object nameobject_nametextRequired
API name of the object.

Outputs

dataobject
Response for a successful list operation.
Example output
{
  "data": {
    "data": [],
    "status": "success"
  }
}

List objects

List objects.

Inputs

None.

Outputs

dataobject
Response for a successful list operation.
Example output
{
  "data": {
    "data": [],
    "status": "success"
  }
}

List sequences

List sequences.

Inputs

Cursorcursortext
Opaque cursor returned by the previous page.
Namenametext
Case-insensitive substring of the sequence name.
Limitlimitnumber
Limit.From 1 to 100.

Outputs

dataobject
Response returned when listing sequences.
Example output
{
  "data": {
    "next_cursor": "example",
    "sequences": []
  }
}

List tasks

List tasks.

Inputs

Cursorcursortext
Opaque cursor returned by the previous page. Pass it unchanged with the same filters and sort order.
Limitlimitnumber
Limit.From 1 to 100.
Sort bysort_bytext
Field to sort by. Defaults to `created_at`. Tasks with the same value are sorted by `id`.One of: created_at (Created at).
Sort ordersort_ordertext
Sort direction. Defaults to descending.One of: asc, desc.
Statusstatustext
Filter tasks by status.One of: NOT_READY (Not ready), READY, COMPLETED, SKIPPED, CANCELED.
Assigned user idassigned_user_idtext
Filter tasks by assignee.
Person idperson_idtext
Filter tasks by person.
Person emailperson_emailtext
Filter tasks by the person's exact email address. Cannot be combined with `person_id`. Email matching is case-insensitive.

Outputs

dataobject
Unify response data.
Example output
{
  "data": {
    "data": [],
    "next_cursor": "example",
    "status": "success"
  }
}

Remove list entries

Remove list entries.

Inputs

Listlist_idtextRequired
String UUIDv4 value.
RecordsrecordslistRequired
Up to 100 record identifiers to remove, processed in request order. ID and match identifiers may be mixed. Duplicate identifiers are not allowed.

Outputs

dataobject
Response for removing records from a list.
Example output
{
  "data": {
    "data": [],
    "status": "success",
    "summary": {
      "not_in_list": 1,
      "removed": 1,
      "total": 1
    }
  }
}

Update list

Update list.

Inputs

Listlist_idtextRequired
String UUIDv4 value.
Namenametext
New name for the list. Must be unique within the workspace.
Share statusshare_statustext
Who can see and change the list.One of: ONLY_ME (Only me), ALL_OTHERS_CAN_VIEW (All others can view), ALL_OTHERS_CAN_EDIT (All others can edit).

Outputs

dataobject
Response for a successful update operation.
Example output
{
  "data": {
    "data": {
      "created_at": "example",
      "id": "example",
      "name": "example",
      "object": "example",
      "owner_id": "example",
      "share_status": "ONLY_ME",
      "updated_at": "example"
    },
    "status": "success"
  }
}

Update object record

Update object record.

Inputs

Object nameobject_nametextRequired
The API name of an object, e.g. `company`, `person`, `opportunity`, or a custom object's API name.
Record idrecord_idtextRequired
Record id.
Validation modevalidation_modetext
Validation mode for request data. - `strict`: Reject requests if any attribute is invalid or unrecognized. - `ignore_invalid`: Ignore unknown attributes and omit invalid values for optional attributes. Reject requests with an invalid body structure or invalid required attributes.One of: strict, ignore_invalid (Ignore invalid).
DatadataobjectRequired
The attribute values to update. Omitted attributes retain their existing values.

Outputs

dataobject
Response for a successful update operation.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "created_at": "example",
      "id": "example",
      "object": "example",
      "updated_at": "example"
    },
    "status": "success"
  }
}

Update task

Update task.

Inputs

IdidtextRequired
Id.
Assigned user idassigned_user_idtext
Assigned user id.
Priorityprioritytext
Priority.One of: LOW, MEDIUM, HIGH, URGENT.
Due atdue_atdate and time
Due at.

Outputs

dataobject
Response for a successful update operation.
Example output
{
  "data": {
    "data": {
      "assigned_user_id": "example",
      "created_at": "example",
      "due_at": "example",
      "ended_at": "example",
      "id": "example",
      "note_content": "example",
      "person_id": "example",
      "priority": "LOW",
      "status": "NOT_READY",
      "type": "EMAIL",
      "updated_at": "example"
    },
    "status": "success"
  }
}

Upsert object record

Upsert object record.

Inputs

Object nameobject_nametextRequired
The API name of an object, e.g. `company`, `person`, `opportunity`, or a custom object's API name.
Validation modevalidation_modetext
Validation mode for request data. - `strict`: Reject requests if any attribute is invalid or unrecognized. - `ignore_invalid`: Ignore unknown attributes and omit invalid values for optional attributes. Reject requests with an invalid body structure or invalid required attributes.One of: strict, ignore_invalid (Ignore invalid).
MatchmatchobjectRequired
Attribute values used to find an existing record. Include at least one unique attribute. Additional attributes narrow the match.
Createcreateobject
Attribute values used when no record matches. These take precedence over other creation values.
Updateupdateobject
Attribute values used when a record matches. These take precedence over other update values.
Update if emptyupdate_if_emptyobject
Attribute values applied to a matching record only where the existing value is `null`. Values in `update` and `create_or_update` take precedence.
Create or updatecreate_or_updateobject
Attribute values used for both creation and updates. Values in `create` or `update` take precedence.
Create or update if emptycreate_or_update_if_emptyobject
Attribute values used for creation, or for updates where the existing value is `null`. Values in all other properties take precedence.

Outputs

dataobject
Response for a successful update operation.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "created_at": "example",
      "id": "example",
      "object": "example",
      "updated_at": "example"
    },
    "status": "success"
  }
}

On this page