# Unify

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

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/unify

## Actions

### Add list entries

Add list entries.

**Inputs**

- List (`list_id`, text, required): String UUIDv4 value.
- Records (`records`, list, required): Up to 100 record identifiers to add, processed in request order. ID and match identifiers may be mixed. Duplicate identifiers are not allowed.

**Outputs**

- `data` (object): Response for adding records to a list.

**Example output**

```json
{
  "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**

- Id (`id`, text, required): Id.

**Outputs**

- `data` (object): Unify response data.

**Example output**

```json
{
  "data": {}
}
```

### Create list

Create list.

**Inputs**

- Name (`name`, text, required): Name of the list. Must be unique within the workspace.
- Object (`object`, text, required): API name of the object whose records the list will hold. Cannot be changed after creation.
- Share status (`share_status`, text): 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**

- `data` (object): Response for a successful create operation.

**Example output**

```json
{
  "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 name (`object_name`, text, required): The API name of an object, e.g. `company`, `person`, `opportunity`, or a custom object's API name.
- Validation mode (`validation_mode`, text): 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).
- Data (`data`, object, required): The attribute values for the new record. All required attributes on the object must be included.

**Outputs**

- `data` (object): Response for a successful create operation.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {},
      "created_at": "example",
      "id": "example",
      "object": "example",
      "updated_at": "example"
    },
    "status": "success"
  }
}
```

### Create task

Create task.

**Inputs**

- Person id (`person_id`, text, required): Person id.
- Priority (`priority`, text): Priority. One of: `LOW`, `MEDIUM`, `HIGH`, `URGENT`.
- Due at (`due_at`, date and time): Due at.

**Outputs**

- `data` (object): Response for a successful create operation.

**Example output**

```json
{
  "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**

- List (`list_id`, text, required): String UUIDv4 value.

**Outputs**

- `data` (object): Response for a successful delete operation.

**Example output**

```json
{
  "data": {
    "status": "success"
  }
}
```

### Delete object record

Delete object record.

**Inputs**

- Object name (`object_name`, text, required): The API name of an object, e.g. `company`, `person`, `opportunity`, or a custom object's API name.
- Record id (`record_id`, text, required): Record id.

**Outputs**

- `data` (object): Response for a successful delete operation.

**Example output**

```json
{
  "data": {
    "status": "success"
  }
}
```

### Delete task

Delete task.

**Inputs**

- Id (`id`, text, required): Id.

**Outputs**

- `data` (object): Response for a successful delete operation.

**Example output**

```json
{
  "data": {
    "status": "success"
  }
}
```

### Find unique object record

Find unique object record.

**Inputs**

- Object name (`object_name`, text, required): The API name of an object, e.g. `company`, `person`, `opportunity`, or a custom object's API name.
- Match (`match`, object, required): Attribute values used to find an existing record. Include at least one unique attribute. Additional attributes narrow the match.

**Outputs**

- `data` (object): Response for a successful get operation.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {},
      "created_at": "example",
      "id": "example",
      "object": "example",
      "updated_at": "example"
    },
    "status": "success"
  }
}
```

### Get list

Get list.

**Inputs**

- List (`list_id`, text, required): String UUIDv4 value.

**Outputs**

- `data` (object): Response for a successful get operation.

**Example output**

```json
{
  "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**

- List (`list_id`, text, required): String UUIDv4 value.
- Entry id (`entry_id`, text, required): String UUIDv4 value.

**Outputs**

- `data` (object): Response for a successful get operation.

**Example output**

```json
{
  "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 name (`object_name`, text, required): The API name of an object, e.g. `company`, `person`, `opportunity`, or a custom object's API name.
- Record id (`record_id`, text, required): Record id.

**Outputs**

- `data` (object): Response for a successful get operation.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {},
      "created_at": "example",
      "id": "example",
      "object": "example",
      "updated_at": "example"
    },
    "status": "success"
  }
}
```

### Get sequence

Get sequence.

**Inputs**

- Id (`id`, text, required): String UUID value.

**Outputs**

- `data` (object): An automated series of outreach steps for enrolled people.

**Example output**

```json
{
  "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**

- Id (`id`, text, required): Id.

**Outputs**

- `data` (object): Response for a successful get operation.

**Example output**

```json
{
  "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**

- List (`list_id`, text, required): String UUIDv4 value.
- Cursor (`cursor`, text): String UUIDv4 value.
- Limit (`limit`, number): Maximum number of entries to return. Defaults to 100. From 1 to 100.

**Outputs**

- `data` (object): Response for a successful paginated list of entries.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_cursor": "example",
    "status": "success"
  }
}
```

### List lists

List lists.

**Inputs**

- Cursor (`cursor`, text): String UUIDv4 value.
- Limit (`limit`, number): Maximum number of lists to return. Defaults to 100. From 1 to 100.
- Object (`object`, text): The API name of an object, e.g. `company`, `person`, `opportunity`, or a custom object's API name.
- Name (`name`, text): Filter lists by exact name.

**Outputs**

- `data` (object): Response for a successful paginated list of lists.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_cursor": "example",
    "status": "success"
  }
}
```

### List object attributes

List object attributes.

**Inputs**

- Object name (`object_name`, text, required): API name of the object.

**Outputs**

- `data` (object): Response for a successful list operation.

**Example output**

```json
{
  "data": {
    "data": [],
    "status": "success"
  }
}
```

### List objects

List objects.

**Inputs**: None.

**Outputs**

- `data` (object): Response for a successful list operation.

**Example output**

```json
{
  "data": {
    "data": [],
    "status": "success"
  }
}
```

### List sequences

List sequences.

**Inputs**

- Cursor (`cursor`, text): Opaque cursor returned by the previous page.
- Name (`name`, text): Case-insensitive substring of the sequence name.
- Limit (`limit`, number): Limit. From 1 to 100.

**Outputs**

- `data` (object): Response returned when listing sequences.

**Example output**

```json
{
  "data": {
    "next_cursor": "example",
    "sequences": []
  }
}
```

### List tasks

List tasks.

**Inputs**

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

**Outputs**

- `data` (object): Unify response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "next_cursor": "example",
    "status": "success"
  }
}
```

### Remove list entries

Remove list entries.

**Inputs**

- List (`list_id`, text, required): String UUIDv4 value.
- Records (`records`, list, required): Up to 100 record identifiers to remove, processed in request order. ID and match identifiers may be mixed. Duplicate identifiers are not allowed.

**Outputs**

- `data` (object): Response for removing records from a list.

**Example output**

```json
{
  "data": {
    "data": [],
    "status": "success",
    "summary": {
      "not_in_list": 1,
      "removed": 1,
      "total": 1
    }
  }
}
```

### Update list

Update list.

**Inputs**

- List (`list_id`, text, required): String UUIDv4 value.
- Name (`name`, text): New name for the list. Must be unique within the workspace.
- Share status (`share_status`, text): 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**

- `data` (object): Response for a successful update operation.

**Example output**

```json
{
  "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 name (`object_name`, text, required): The API name of an object, e.g. `company`, `person`, `opportunity`, or a custom object's API name.
- Record id (`record_id`, text, required): Record id.
- Validation mode (`validation_mode`, text): 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).
- Data (`data`, object, required): The attribute values to update. Omitted attributes retain their existing values.

**Outputs**

- `data` (object): Response for a successful update operation.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {},
      "created_at": "example",
      "id": "example",
      "object": "example",
      "updated_at": "example"
    },
    "status": "success"
  }
}
```

### Update task

Update task.

**Inputs**

- Id (`id`, text, required): Id.
- Assigned user id (`assigned_user_id`, text): Assigned user id.
- Priority (`priority`, text): Priority. One of: `LOW`, `MEDIUM`, `HIGH`, `URGENT`.
- Due at (`due_at`, date and time): Due at.

**Outputs**

- `data` (object): Response for a successful update operation.

**Example output**

```json
{
  "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 name (`object_name`, text, required): The API name of an object, e.g. `company`, `person`, `opportunity`, or a custom object's API name.
- Validation mode (`validation_mode`, text): 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).
- Match (`match`, object, required): Attribute values used to find an existing record. Include at least one unique attribute. Additional attributes narrow the match.
- Create (`create`, object): Attribute values used when no record matches. These take precedence over other creation values.
- Update (`update`, object): Attribute values used when a record matches. These take precedence over other update values.
- Update if empty (`update_if_empty`, object): 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 update (`create_or_update`, object): Attribute values used for both creation and updates. Values in `create` or `update` take precedence.
- Create or update if empty (`create_or_update_if_empty`, object): Attribute values used for creation, or for updates where the existing value is `null`. Values in all other properties take precedence.

**Outputs**

- `data` (object): Response for a successful update operation.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {},
      "created_at": "example",
      "id": "example",
      "object": "example",
      "updated_at": "example"
    },
    "status": "success"
  }
}
```
