# Operations (sample payloads)

## Main operations

### Add prospect to sequence

Add a prospect to a sequence in your Outreach account.
**Sample Input**
**Sample Output**

### Create account

Create an account in your Outreach account.
**Sample Input**
**Sample Output**

### Create call

Create a new call in your outreach account.
**Sample Input**
**Sample Output**

```json
{
    "data": {
        "type": "call",
        "id": 12345,
        "attributes": \{
            "answeredAt": "2023-05-15T14:30:00Z",
            "completedAt": "2023-05-15T14:35:00Z",
            "createdAt": "2023-05-15T14:29:55Z",
            "dialedAt": "2023-05-15T14:29:58Z",
            "direction": "outbound",
            "from": "+14155551234",
            "to": "+14155555678",
            "note": "Discussed product features and pricing",
            "outcome": "completed",
            "recordingUrl": "https://example.com/recordings/call123.mp3",
            "sequenceAction": "advance",
            "state": "completed",
            "stateChangedAt": "2023-05-15T14:35:00Z",
            "tags": [
                "sales",
                "follow-up"
            ],
            "updatedAt": "2023-05-15T14:35:05Z",
            "userCallType": "outbound"
        \},
        "relationships": {
            "callDisposition": {
                "data": \{
                    "type": "callDisposition",
                    "id": 1
                \}
            },
            "callPurpose": {
                "data": \{
                    "type": "callPurpose",
                    "id": 2
                \}
            },
            "prospect": {
                "data": \{
                    "type": "prospect",
                    "id": 3456
                \}
            },
            "user": {
                "data": \{
                    "type": "user",
                    "id": 789
                \}
            }
        },
        "links": {
            "self": "https://api.outreach.io/api/v2/calls/12345"
        }
    }
}
```

### Create call disposition

Create a new call disposition in your outreach account.
**Sample Input**
**Sample Output**

### Create call purpose

Create a call purpose in your Outreach account.
**Sample Input**
**Sample Output**

### Create compliance request

Create a new compliance request in your Outreach account.
**Sample Input**

```json
\{
    "requester_email": "john.doe@example.com",
    "request_type": "Delete",
    "object_type": "Prospect",
    "request_object_email": "jane.smith@company.com"
\}
```

**Sample Output**

### Create mailing

Create a new mailing in your outreach account.
**Sample Input**
**Sample Output**

### Create opportunity

Create an opportunity in your Outreach account.
**Sample Input**
**Sample Output**

### Create opportunity prospect role

Create an opportunity prospect role in your Outreach account.
**Sample Input**
**Sample Output**

### Create opportunity stage

Create an opportunity stage in your Outreach account.
**Sample Input**
**Sample Output**

### Create prospect

Create a prospect in your Outreach account.
**Sample Input**
**Sample Output**

### Create sequence

Create a sequence in your Outreach account.
**Sample Input**
**Sample Output**

### Create sequence state

Create a sequence state in your Outreach account.
**Sample Input**

```json
{
    "relationships": \{
        "mailbox": 123,
        "prospect": 456,
        "sequence": 789
    \}
}
```

**Sample Output**

### Create stage

Create a stage in your Outreach account.
**Sample Input**
**Sample Output**

```json
{
    "data": {
        "type": "stage",
        "id": 123,
        "attributes": \{
            "color": "#4CAF50",
            "createdAt": "2023-05-15T14:30:00Z",
            "name": "Qualified Lead",
            "order": 2,
            "updatedAt": "2023-05-15T14:30:00Z"
        \},
        "relationships": {
            "creator": {
                "data": \{
                    "type": "user",
                    "id": 456
                \}
            },
            "prospects": {
                "links": {
                    "related": "https://api.outreach.io/api/v2/stages/123/prospects"
                }
            },
            "updater": {
                "data": \{
                    "type": "user",
                    "id": 456
                \}
            }
        },
        "links": {
            "self": "https://api.outreach.io/api/v2/stages/123"
        }
    }
}
```

### Create task

Create a task in your Outreach account.
**Sample Input**
**Sample Output**

### Delete account

Delete an account from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

```json
{
    "deleted": true
}
```

### Delete call

Deletes a call from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

### Delete call disposition

Delete an call disposition from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

```json
{
    "deleted": true
}
```

### Delete call purpose

Delete an call purpose from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

### Delete opportunity

Delete an opportunity from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

```json
{
    "deleted": true
}
```

### Delete opportunity prospect role

Delete an opportunity prospect role from your Outreach account, using their unique ID.
**Sample Input**

```json
{
    "prospect_role_id": 12345
}
```

**Sample Output**

### Delete opportunity stage

Delete an opportunity stage from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

### Delete prospect

Deletes a prospect from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

```json
{
    "deleted": true
}
```

### Delete sequence

Delete a sequence in your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

### Delete sequence state

Delete a sequence state in your Outreach account, using it's unique ID.
**Sample Input**
**Sample Output**

```json
{
    "deleted": true
}
```

### Delete stage

Delete a stage in your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

### Delete task

Delete a task from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

```json
{
    "deleted": true
}
```

### Execute link

Execute a link provided by the Outreach API and return it's results. Note: only 'GET' requests will be performed.
**Sample Input**
**Sample Output**

```json
{
    "data": {
        "type": "prospect",
        "id": 123,
        "attributes": \{
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@example.com",
            "title": "Sales Manager",
            "company": "Acme Corp",
            "createdAt": "2023-05-15T10:30:00Z",
            "updatedAt": "2023-05-16T14:45:00Z"
        \},
        "relationships": {
            "account": {
                "data": \{
                    "type": "account",
                    "id": 456
                \}
            },
            "owner": {
                "data": \{
                    "type": "user",
                    "id": 789
                \}
            }
        }
    }
}
```

### Get account

Gets an account from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

### Get call

Gets a call from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

```json
{
    "data": {
        "type": "call",
        "id": 12345,
        "attributes": \{
            "answeredAt": "2023-05-15T14:30:00Z",
            "direction": "outbound",
            "from": "+14155551234",
            "to": "+14155555678",
            "state": "completed",
            "outcome": "connected"
        \},
        "relationships": {
            "user": {
                "data": \{
                    "type": "user",
                    "id": 789
                \}
            },
            "prospect": {
                "data": \{
                    "type": "prospect",
                    "id": 456
                \}
            }
        },
        "links": {
            "self": "https://api.outreach.io/api/v2/calls/12345"
        }
    }
}
```

### Get call disposition

Gets a call disposition from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

### Get call purpose

Gets a call purpose from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

### Get compliance request

Retrieve the details for a specific compliance request.
**Sample Input**
**Sample Output**

```json
{
    "data": {
        "type": "complianceRequest",
        "id": 12345,
        "attributes": {
            "batchComplianceRequestUuid": "b1c2d3e4-f5g6-h7i8-j9k0-l1m2n3o4p5q6",
            "createdAt": "2023-06-15T10:30:00Z",
            "objectType": "prospect",
            "pii": {
                "email": "john.doe@example.com"
            },
            "requestType": "delete",
            "state": "completed"
        },
        "relationships": {
            "requester": {
                "data": \{
                    "type": "user",
                    "id": 67890
                \}
            }
        },
        "links": {
            "self": "https://api.outreach.io/api/v2/complianceRequests/12345"
        }
    }
}
```

### Get event

Gets an event from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

### Get mailbox

Gets a mailbox from your Outreach account, using its unique ID.
**Sample Input**
**Sample Output**

### Get mailing

Gets a mailing from your Outreach account, using its unique ID.
**Sample Input**

```json
\{
    "mailing_id": 12345,
    "fields": [
        "subject",
        "bodyHtml",
        "createdAt",
        "state",
        "openCount"
    ]
\}
```

**Sample Output**

```json
{
    "data": {
        "type": "mailing",
        "id": 12345,
        "attributes": \{
            "subject": "Important Update: New Product Launch",
            "bodyHtml": "<html><body><h1>Exciting News!</h1><p>We're thrilled to announce our new product launch...</p></body></html>",
            "createdAt": "2023-05-15T10:30:00Z",
            "state": "delivered",
            "openCount": 157
        \},
        "relationships": {
            "mailbox": {
                "data": \{
                    "type": "mailbox",
                    "id": 789
                \}
            },
            "prospect": {
                "data": \{
                    "type": "prospect",
                    "id": 456
                \}
            },
            "sequence": {
                "data": \{
                    "type": "sequence",
                    "id": 101
                \}
            }
        },
        "links": {
            "self": "https://api.outreach.io/api/v2/mailings/12345"
        }
    }
}
```

### Get opportunity

Gets an opportunity from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

### Get opportunity prospect role

Gets an opportunity prospect role from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

### Get opportunity stage

Gets an opportunity stage from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

```json
{
    "data": {
        "type": "opportunityStage",
        "id": 123,
        "attributes": \{
            "color": "#4CAF50",
            "createdAt": "2023-05-15T10:30:00Z",
            "name": "Qualified",
            "order": 2,
            "updatedAt": "2023-05-15T10:30:00Z"
        \},
        "relationships": {
            "creator": {
                "data": \{
                    "type": "user",
                    "id": 456
                \}
            },
            "opportunities": {
                "links": {
                    "related": "https://api.outreach.io/api/v2/opportunityStages/123/opportunities"
                }
            }
        },
        "links": {
            "self": "https://api.outreach.io/api/v2/opportunityStages/123"
        }
    }
}
```

### Get phone number

Gets a phone number of a prospect from your Outreach account, using the phone number ID.
**Sample Input**
**Sample Output**

### Get prospect

Gets a prospect from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

```json
{
    "data": {
        "type": "prospect",
        "id": 12345,
        "attributes": \{
            "firstName": "John",
            "lastName": "Doe",
            "emails": [
                "john.doe@example.com"
            ],
            "title": "Sales Manager",
            "workPhones": [
                "+1 (555) 123-4567"
            ],
            "name": "John Doe",
            "createdAt": "2023-05-15T10:30:00Z",
            "updatedAt": "2023-05-15T10:30:00Z"
        \},
        "relationships": {
            "account": {
                "data": \{
                    "type": "account",
                    "id": 67890
                \}
            },
            "owner": {
                "data": \{
                    "type": "user",
                    "id": 54321
                \}
            }
        },
        "links": {
            "self": "https://api.outreach.io/api/v2/prospects/12345"
        }
    }
}
```

### Get sequence

Gets a sequence from your Outreach account, using their unique ID.
**Sample Input**

```json
\{
    "sequence_id": 123456,
    "fields": [
        "name",
        "description",
        "enabled",
        "createdAt",
        "updatedAt",
        "tags"
    ]
\}
```

**Sample Output**

### Get sequence state

Gets a sequence state from your Outreach account, using the sequence state ID.
**Sample Input**
**Sample Output**

### Get sequence step

Gets a sequence step from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

### Get stage

Gets a stage from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

```json
{
    "data": {
        "type": "stage",
        "id": 123,
        "attributes": \{
            "name": "Qualified",
            "color": "#4CAF50",
            "order": 2
        \},
        "relationships": {
            "creator": {
                "data": \{
                    "type": "user",
                    "id": 456
                \}
            },
            "prospects": {
                "links": {
                    "related": "https://api.outreach.io/api/v2/stages/123/prospects"
                }
            },
            "updater": {
                "data": \{
                    "type": "user",
                    "id": 789
                \}
            }
        },
        "links": {
            "self": "https://api.outreach.io/api/v2/stages/123"
        }
    }
}
```

### Get task

Gets a task from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

### Get user

Gets a user from your Outreach account, using its unique ID.
**Sample Input**
**Sample Output**

### List accounts

Get a list of accounts in your Outreach account.
**Sample Input**
**Sample Output**

### List audits

Retrieve a list of events that happen during the day.
**Sample Input**
**Sample Output**

```json
{
    "links": \{
        "first": "https://api.outreach.io/api/v2/audits?page[size]=50&sort=-timestamp",
        "prev": null
    \},
    "data": [
        {
            "id": "12345",
            "type": "audit",
            "attributes": \{
                "user": "john.doe@example.com",
                "userId": 67890,
                "requestIp": "192.168.1.100",
                "timestamp": "2023-05-31T15:45:30Z",
                "eventName": "login",
                "orgId": "org_123456"
            \}
        },
        {
            "id": "12346",
            "type": "audit",
            "attributes": \{
                "user": "jane.smith@example.com",
                "userId": 67891,
                "requestIp": "192.168.1.101",
                "timestamp": "2023-05-31T14:30:15Z",
                "eventName": "login",
                "orgId": "org_123456"
            \}
        }
    ],
    "meta": {
        "count": 2
    }
}
```

### List call dispositions

List all call dispositions in your account
**Sample Input**

```json
{
    "page_size": 50,
    "filters": [
        \{
            "field": "outcome",
            "criteria": "positive"
        \}
    ],
    "sort": \{
        "sort_by": "name",
        "sort_direction": "asc"
    \},
    "fields": [
        "name",
        "outcome",
        "order"
    ]
}
```

**Sample Output**

### List call purposes

List all call purposes in your account
**Sample Input**

```json
{
    "page_size": 50,
    "filters": [
        \{
            "field": "name",
            "criteria": "Follow-up"
        \}
    ],
    "sort": \{
        "sort_by": "order",
        "sort_direction": "asc"
    \},
    "fields": [
        "name",
        "order",
        "createdAt"
    ]
}
```

**Sample Output**

### List compliance requests

Retrieve a list of regulatory requests to delete or export personal information.
**Sample Input**
**Sample Output**

### List events

Get a list of events in your Outreach account.
**Sample Input**
**Sample Output**

### List mail aliases

Get a list of alternative email names for a mailboxes in your Outreach account.
**Sample Input**
**Sample Output**

### List mailboxes

Get a list of mailboxes in your Outreach account.
**Sample Input**

```json
{
    "page_size": 2,
    "fields": [
        "email",
        "emailProvider",
        "createdAt",
        "updatedAt"
    ],
    "sort": \{
        "sort_by": "createdAt",
        "sort_direction": "desc"
    \},
    "filters": [
        \{
            "field": "emailProvider",
            "criteria": "Gmail"
        \}
    ]
}
```

**Sample Output**

### List mailings

Get a list of mailings in your Outreach account.
**Sample Input**
**Sample Output**

```json
{
    "data": [
        {
            "type": "mailing",
            "id": 12345,
            "attributes": \{
                "subject": "Follow-up on our recent conversation",
                "createdAt": "2023-06-15T10:30:00Z",
                "state": "delivered",
                "mailingType": "sequence",
                "openCount": 3,
                "clickCount": 1
            \},
            "relationships": {
                "prospect": {
                    "data": \{
                        "type": "prospect",
                        "id": 67890
                    \}
                },
                "sequence": {
                    "data": \{
                        "type": "sequence",
                        "id": 54321
                    \}
                }
            },
            "links": {
                "self": "https://api.outreach.io/api/v2/mailings/12345"
            }
        },
        {
            "type": "mailing",
            "id": 12346,
            "attributes": \{
                "subject": "Exclusive offer for you",
                "createdAt": "2023-06-14T15:45:00Z",
                "state": "opened",
                "mailingType": "sequence",
                "openCount": 2,
                "clickCount": 0
            \},
            "relationships": {
                "prospect": {
                    "data": \{
                        "type": "prospect",
                        "id": 67891
                    \}
                },
                "sequence": {
                    "data": \{
                        "type": "sequence",
                        "id": 54321
                    \}
                }
            },
            "links": {
                "self": "https://api.outreach.io/api/v2/mailings/12346"
            }
        }
    ],
    "meta": {
        "count": 2
    }
}
```

### List opportunities

Get a list of opportunities in your Outreach account.
**Sample Input**
**Sample Output**

### List opportunity prospect roles

Get a list of opportunity prospect roles in your Outreach account
**Sample Input**
**Sample Output**

### List opportunity stages

Get a list of opportunity stages in your Outreach account.
**Sample Input**

```json
{
    "page_size": 50,
    "filters": [
        \{
            "field": "name",
            "criteria": "Qualified"
        \}
    ],
    "sort": \{
        "sort_by": "order",
        "sort_direction": "asc"
    \},
    "fields": [
        "name",
        "order",
        "color"
    ]
}
```

**Sample Output**

```json
{
    "data": [
        {
            "type": "opportunityStage",
            "id": 1,
            "attributes": \{
                "name": "Qualified",
                "order": 1,
                "color": "#4CAF50"
            \},
            "relationships": {
                "creator": {
                    "data": \{
                        "type": "user",
                        "id": 101
                    \}
                },
                "opportunities": {
                    "links": {
                        "related": "https://api.outreach.io/api/v2/opportunityStages/1/opportunities"
                    }
                }
            },
            "links": {
                "self": "https://api.outreach.io/api/v2/opportunityStages/1"
            }
        },
        {
            "type": "opportunityStage",
            "id": 2,
            "attributes": \{
                "name": "Discovery",
                "order": 2,
                "color": "#2196F3"
            \},
            "relationships": {
                "creator": {
                    "data": \{
                        "type": "user",
                        "id": 102
                    \}
                },
                "opportunities": {
                    "links": {
                        "related": "https://api.outreach.io/api/v2/opportunityStages/2/opportunities"
                    }
                }
            },
            "links": {
                "self": "https://api.outreach.io/api/v2/opportunityStages/2"
            }
        }
    ],
    "meta": {
        "count": 2
    }
}
```

### List phone numbers

Get a list of phone numbers of prospects in your Outreach account.
**Sample Input**
**Sample Output**

### List prospects

Get a list of recent prospects in your Outreach account.
**Sample Input**

```json
{
    "page_size": 2,
    "filters": [
        \{
            "field": "company",
            "criteria": "Acme Inc"
        \}
    ],
    "sort": \{
        "sort_by": "createdAt",
        "sort_direction": "desc"
    \},
    "fields": [
        "firstName",
        "lastName",
        "company",
        "title",
        "emails"
    ]
}
```

**Sample Output**

### List recipients

Get a list of recipients in your Outreach account.
**Sample Input**
**Sample Output**

```json
{
    "data": [
        {
            "type": "recipient",
            "id": 12345,
            "attributes": \{
                "createdAt": "2023-05-15T10:30:00Z",
                "emailHash": "a1b2c3d4e5f6g7h8i9j0",
                "recipientType": "email",
                "value": "john.doe@example.com"
            \},
            "links": {
                "self": "https://api.outreach.io/api/v2/recipients/12345"
            }
        },
        {
            "type": "recipient",
            "id": 12346,
            "attributes": \{
                "createdAt": "2023-05-14T15:45:00Z",
                "emailHash": "k1l2m3n4o5p6q7r8s9t0",
                "recipientType": "email",
                "value": "jane.smith@example.com"
            \},
            "links": {
                "self": "https://api.outreach.io/api/v2/recipients/12346"
            }
        }
    ],
    "meta": {
        "count": 2
    },
    "links": {
        "first": "https://api.outreach.io/api/v2/recipients?page[limit]=50&sort=-createdAt"
    }
}
```

### List sequence states

Get a list of sequence states in your Outreach account.
**Sample Input**
**Sample Output**

```json
{
    "data": [
        {
            "type": "sequenceState",
            "id": 12345,
            "attributes": \{
                "state": "active",
                "createdAt": "2023-05-15T10:30:00Z",
                "updatedAt": "2023-05-15T10:30:00Z",
                "activeAt": "2023-05-15T10:30:00Z"
            \},
            "relationships": {
                "sequence": {
                    "data": \{
                        "type": "sequence",
                        "id": 67890
                    \}
                },
                "prospect": {
                    "data": \{
                        "type": "prospect",
                        "id": 54321
                    \}
                }
            },
            "links": {
                "self": "https://api.outreach.io/api/v2/sequenceStates/12345"
            }
        },
        {
            "type": "sequenceState",
            "id": 12346,
            "attributes": \{
                "state": "active",
                "createdAt": "2023-05-14T15:45:00Z",
                "updatedAt": "2023-05-14T15:45:00Z",
                "activeAt": "2023-05-14T15:45:00Z"
            \},
            "relationships": {
                "sequence": {
                    "data": \{
                        "type": "sequence",
                        "id": 67891
                    \}
                },
                "prospect": {
                    "data": \{
                        "type": "prospect",
                        "id": 54322
                    \}
                }
            },
            "links": {
                "self": "https://api.outreach.io/api/v2/sequenceStates/12346"
            }
        }
    ],
    "meta": {
        "count": 2
    }
}
```

### List sequence steps

Get a list of sequence steps in your Outreach account.
**Sample Input**
**Sample Output**

### List sequences

Get a list of sequences in your Outreach account.
**Sample Input**

```json
{
    "page_size": 2,
    "filters": [
        \{
            "field": "name",
            "criteria": "Welcome Sequence"
        \}
    ],
    "sort": \{
        "sort_by": "createdAt",
        "sort_direction": "desc"
    \},
    "fields": [
        "name",
        "description",
        "createdAt",
        "enabled"
    ]
}
```

**Sample Output**

### List stages

Get a list of stages in your Outreach account.
**Sample Input**
**Sample Output**

### List task priorities

Get a list of task priorities in your Outreach account.
**Sample Input**
**Sample Output**

### List tasks

Get a list of recent tasks in your Outreach account.
**Sample Input**
**Sample Output**

```json
{
    "data": [
        {
            "type": "task",
            "id": 12345,
            "attributes": \{
                "action": "Call",
                "dueAt": "2023-06-15T10:00:00Z",
                "note": "Follow up on proposal",
                "state": "incomplete",
                "taskType": "follow_up"
            \},
            "relationships": {
                "prospect": {
                    "data": \{
                        "type": "prospect",
                        "id": 67890
                    \}
                },
                "owner": {
                    "data": \{
                        "type": "user",
                        "id": 11111
                    \}
                }
            },
            "links": {
                "self": "https://api.outreach.io/api/v2/tasks/12345"
            }
        },
        {
            "type": "task",
            "id": 12346,
            "attributes": \{
                "action": "Email",
                "dueAt": "2023-06-20T14:30:00Z",
                "note": "Send product demo",
                "state": "incomplete",
                "taskType": "demo"
            \},
            "relationships": {
                "prospect": {
                    "data": \{
                        "type": "prospect",
                        "id": 67891
                    \}
                },
                "owner": {
                    "data": \{
                        "type": "user",
                        "id": 11112
                    \}
                }
            },
            "links": {
                "self": "https://api.outreach.io/api/v2/tasks/12346"
            }
        }
    ],
    "meta": {
        "count": 2
    }
}
```

### List templates

Get a list of templates in your Outreach account.
**Sample Input**
**Sample Output**

### List users

Get a list of users in your Outreach account.
**Sample Input**
**Sample Output**

### Raw HTTP request (advanced)

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.
**Sample Input**
**Sample Output**

### Set sequence state action

Set an action on a sequence state from your Outreach account, using it's unique ID.
**Sample Input**
**Sample Output**

### Set task action

Set an action on a task from your Outreach account, using their unique ID.
**Sample Input**
**Sample Output**

### Update account

Update an account by ID in your Outreach account.
**Sample Input**
**Sample Output**

### Update call disposition

Update a call disposition in your outreach account.
**Sample Input**

```json
{
    "call_disposition_id": 123,
    "attributes": \{
        "name": "Follow-up Required",
        "order": 2,
        "outcome": "completed"
    \}
}
```

**Sample Output**

### Update call purpose

Update a call purpose in your outreach account.
**Sample Input**

```json
{
    "call_purpose_id": 123,
    "attributes": \{
        "name": "Follow-up Call",
        "order": 2
    \}
}
```

**Sample Output**

### Update opportunity

Update an opportunity by ID in your Outreach account.
**Sample Input**
**Sample Output**

### Update opportunity prospect role

Update an opportunity by ID in your Outreach account.
**Sample Input**
**Sample Output**

### Update opportunity stage

Update an opportunity stage by ID in your Outreach account.
**Sample Input**
**Sample Output**

```json
{
    "data": {
        "type": "opportunityStage",
        "id": 123,
        "attributes": \{
            "color": "#FFA500",
            "createdAt": "2023-05-15T10:30:00Z",
            "name": "Negotiation",
            "order": 3,
            "updatedAt": "2023-05-15T14:45:00Z"
        \},
        "relationships": {
            "creator": {
                "data": \{
                    "type": "user",
                    "id": 456
                \}
            },
            "opportunities": {
                "links": {
                    "related": "https://api.outreach.io/api/v2/opportunityStages/123/opportunities"
                }
            }
        },
        "links": {
            "self": "https://api.outreach.io/api/v2/opportunityStages/123"
        }
    }
}
```

### Update stage

Update a stage by ID in your Outreach account.
**Sample Input**

```json
{
    "stage_id": 123,
    "attributes": \{
        "name": "Qualified Lead",
        "color": "#4287f5",
        "order": 2
    \}
}
```

**Sample Output**

```json
{
    "data": {
        "type": "stage",
        "id": 123,
        "attributes": \{
            "color": "#4287f5",
            "createdAt": "2023-05-15T10:30:00Z",
            "name": "Qualified Lead",
            "order": 2,
            "updatedAt": "2023-05-15T14:45:00Z"
        \},
        "relationships": {
            "creator": {
                "data": \{
                    "type": "user",
                    "id": 456
                \}
            },
            "prospects": {
                "links": {
                    "related": "https://api.outreach.io/api/v2/stages/123/prospects"
                }
            },
            "updater": {
                "data": \{
                    "type": "user",
                    "id": 789
                \}
            }
        },
        "links": {
            "self": "https://api.outreach.io/api/v2/stages/123"
        }
    }
}
```

## DDL operations

### List accounts (DDL)

> **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

**Sample Input**
**Sample Output**

```json
{
    "data": [
        {
            "id": 1234,
            "name": "Acme Corporation",
            "domain": "acmecorp.com",
            "createdAt": "2023-05-15T10:30:00Z",
            "updatedAt": "2023-05-15T10:30:00Z",
            "customFields": \{
                "industry": "Technology",
                "employeeCount": 500
            \}
        },
        {
            "id": 5678,
            "name": "Global Innovations Ltd",
            "domain": "globalinnovations.com",
            "createdAt": "2023-05-14T09:15:00Z",
            "updatedAt": "2023-05-15T14:45:00Z",
            "customFields": \{
                "industry": "Manufacturing",
                "employeeCount": 1000
            \}
        }
    ],
    "meta": \{
        "total": 2,
        "count": 2,
        "hasMore": false
    \}
}
```

### List call dispositions (DDL)

> **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

**Sample Input**
**Sample Output**

```json
[
    \{
        "id": 1,
        "name": "Interested",
        "description": "Prospect showed interest in our product"
    \},
    \{
        "id": 2,
        "name": "Not Interested",
        "description": "Prospect explicitly stated they are not interested"
    \},
    \{
        "id": 3,
        "name": "Call Back Later",
        "description": "Prospect requested to be contacted at a later time"
    \},
    \{
        "id": 4,
        "name": "Wrong Number",
        "description": "The number dialed was incorrect or no longer in service"
    \},
    \{
        "id": 5,
        "name": "Voicemail",
        "description": "Left a voicemail message for the prospect"
    \}
]
```

### List call purposes (DDL)

> **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

**Sample Input**
**Sample Output**

```json
[
    \{
        "id": 1,
        "name": "Introduction",
        "description": "Initial call to introduce our product or service"
    \},
    \{
        "id": 2,
        "name": "Follow-up",
        "description": "Follow-up call after initial contact"
    \},
    \{
        "id": 3,
        "name": "Demo Request",
        "description": "Schedule a product demonstration"
    \},
    \{
        "id": 4,
        "name": "Proposal Discussion",
        "description": "Discuss proposal details with the prospect"
    \},
    \{
        "id": 5,
        "name": "Closing",
        "description": "Final call to close the deal"
    \}
]
```

### List mailboxes (DDL)

**Sample Input**
**Sample Output**

```json
[
    \{
        "id": 1234,
        "name": "Sales Team Mailbox",
        "email": "sales@company.com",
        "created_at": "2023-05-15T10:30:00Z",
        "updated_at": "2023-05-15T10:30:00Z"
    \},
    \{
        "id": 5678,
        "name": "Support Team Mailbox",
        "email": "support@company.com",
        "created_at": "2023-05-15T11:15:00Z",
        "updated_at": "2023-05-15T11:15:00Z"
    \},
    \{
        "id": 9012,
        "name": "Marketing Team Mailbox",
        "email": "marketing@company.com",
        "created_at": "2023-05-15T12:00:00Z",
        "updated_at": "2023-05-15T12:00:00Z"
    \}
]
```

### List opportunities (DDL)

**Sample Input**
**Sample Output**

```json
{
    "opportunities": [
        \{
            "id": 123456,
            "name": "Enterprise Software Deal",
            "amount": 100000,
            "stage": "Proposal",
            "probability": 60,
            "closeDate": "2023-12-31",
            "accountId": 789012,
            "ownerId": 345678,
            "createdAt": "2023-06-15T10:30:00Z",
            "updatedAt": "2023-06-20T14:45:00Z"
        \},
        \{
            "id": 234567,
            "name": "Cloud Migration Project",
            "amount": 75000,
            "stage": "Negotiation",
            "probability": 80,
            "closeDate": "2023-09-30",
            "accountId": 890123,
            "ownerId": 456789,
            "createdAt": "2023-05-01T09:00:00Z",
            "updatedAt": "2023-06-18T11:20:00Z"
        \}
    ]
}
```

### List opportunity stages (DDL)

**Sample Input**
**Sample Output**

```json
[
    \{
        "id": 1,
        "name": "Qualification",
        "value": "qualification"
    \},
    \{
        "id": 2,
        "name": "Discovery",
        "value": "discovery"
    \},
    \{
        "id": 3,
        "name": "Proposal",
        "value": "proposal"
    \},
    \{
        "id": 4,
        "name": "Negotiation",
        "value": "negotiation"
    \},
    \{
        "id": 5,
        "name": "Closed Won",
        "value": "closed_won"
    \},
    \{
        "id": 6,
        "name": "Closed Lost",
        "value": "closed_lost"
    \}
]
```

### List phone numbers (DDL)

**Sample Input**
**Sample Output**

```json
[
    \{
        "id": 1,
        "number": "+1 (555) 123-4567",
        "type": "mobile",
        "primary": true
    \},
    \{
        "id": 2,
        "number": "+1 (555) 987-6543",
        "type": "work",
        "primary": false
    \},
    \{
        "id": 3,
        "number": "+1 (555) 246-8135",
        "type": "home",
        "primary": false
    \}
]
```

### List prospects (DDL)

**Sample Input**

```json
{}
```

**Sample Output**

### List sequence states (DDL)

**Sample Input**
**Sample Output**

### List sequence steps (DDL)

**Sample Input**
**Sample Output**

```json
[
    {
        "id": 123456,
        "sequenceId": 78901,
        "stepType": "email",
        "title": "Initial Outreach",
        "order": 1,
        "waitDuration": 2,
        "waitUnit": "days",
        "emailSubject": "Introducing Our Product",
        "emailBody": "Dear \{\{prospect.firstName\}\},\n\nI hope this email finds you well...",
        "enabled": true,
        "createdAt": "2023-05-15T10:30:00Z",
        "updatedAt": "2023-05-15T10:30:00Z"
    },
    \{
        "id": 123457,
        "sequenceId": 78901,
        "stepType": "call",
        "title": "Follow-up Call",
        "order": 2,
        "waitDuration": 3,
        "waitUnit": "days",
        "callInstructions": "Mention the email sent and ask if they have any questions.",
        "enabled": true,
        "createdAt": "2023-05-15T10:31:00Z",
        "updatedAt": "2023-05-15T10:31:00Z"
    \},
    {
        "id": 123458,
        "sequenceId": 78901,
        "stepType": "email",
        "title": "Final Follow-up",
        "order": 3,
        "waitDuration": 5,
        "waitUnit": "days",
        "emailSubject": "Quick check-in",
        "emailBody": "Hi \{\{prospect.firstName\}\},\n\nI wanted to follow up on our previous communication...",
        "enabled": true,
        "createdAt": "2023-05-15T10:32:00Z",
        "updatedAt": "2023-05-15T10:32:00Z"
    }
]
```

### List sequences (DDL)

**Sample Input**
**Sample Output**

### List stages (DDL)

> **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

**Sample Input**
**Sample Output**

```json
{
    "data": [
        \{
            "id": 1,
            "name": "Prospecting",
            "type": "default",
            "createdAt": "2023-05-01T10:00:00Z",
            "updatedAt": "2023-05-01T10:00:00Z"
        \},
        \{
            "id": 2,
            "name": "Qualified",
            "type": "default",
            "createdAt": "2023-05-01T10:01:00Z",
            "updatedAt": "2023-05-01T10:01:00Z"
        \},
        \{
            "id": 3,
            "name": "Demo Scheduled",
            "type": "custom",
            "createdAt": "2023-05-02T14:30:00Z",
            "updatedAt": "2023-05-02T14:30:00Z"
        \},
        \{
            "id": 4,
            "name": "Proposal Sent",
            "type": "custom",
            "createdAt": "2023-05-03T09:15:00Z",
            "updatedAt": "2023-05-03T09:15:00Z"
        \},
        \{
            "id": 5,
            "name": "Closed Won",
            "type": "default",
            "createdAt": "2023-05-01T10:02:00Z",
            "updatedAt": "2023-05-01T10:02:00Z"
        \}
    ],
    "meta": \{
        "count": 5,
        "total_pages": 1,
        "current_page": 1
    \}
}
```

### List task priorities (DDL)

**Sample Input**
**Sample Output**

```json
[
    \{
        "id": 1,
        "name": "High",
        "color": "red"
    \},
    \{
        "id": 2,
        "name": "Medium",
        "color": "yellow"
    \},
    \{
        "id": 3,
        "name": "Low",
        "color": "green"
    \},
    \{
        "id": 4,
        "name": "Urgent",
        "color": "purple"
    \}
]
```

### List templates (DDL)

**Sample Input**

```json
{}
```

**Sample Output**

### List users (DDL)

**Sample Input**
**Sample Output**