| 1 | {"openapi":"3.0.0","info":{"contact":{"email":"integrations@salesloft.com","x-twitter":"SalesLoft"},"description":"SalesLoft helps transform sales teams into modern sales organizations - converting more target accounts into customer accounts\n","title":"SalesLoft Platform","version":"v2","x-apisguru-categories":["customer_relation"],"x-logo":{"url":"https://twitter.com/SalesLoft/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://developers.salesloft.com/v2_api_def.json","version":"2.0"}],"x-providerName":"salesloft.com"},"tags":[{"description":"User Information","name":"Me"},{"description":"Team Information","name":"Team"},{"description":"Account Management","name":"Accounts"},{"description":"Actions","name":"Actions"},{"description":"Actions - Call Instructions","name":"Action Details - Call Instructions"},{"description":"CRM Activity Management","name":"CRM Activities"},{"description":"Cadence Management","name":"Cadences"},{"description":"Cadence Membership","name":"Cadence Memberships"},{"description":"Call Data Record Management","name":"Call Data Records"},{"description":"Call Management","name":"Calls"},{"description":"Caller ID Information","name":"Caller IDs"},{"description":"Custom Field Management","name":"Custom Fields"},{"description":"Email Management","name":"Emails"},{"description":"Email Templates Management","name":"Email Templates"},{"description":"Import Management","name":"Imports"},{"description":"Note Management","name":"Notes"},{"description":"Person Management","name":"People"},{"description":"Person Stage Management","name":"Person Stages"},{"description":"Recording Settings Information","name":"Recording Settings"},{"description":"Steps","name":"Steps"},{"description":"Success Management","name":"Successes"},{"description":"Team Template Management","name":"Team Templates"},{"description":"User Management","name":"Users"}],"paths":{"/v2/accounts.json":{"get":{"description":"Fetches multiple account records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of accounts to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Domain of the accounts to fetch. Domains are unique and lowercase","in":"query","name":"domain","required":false,"schema":{"type":"string"}},{"description":"Key to sort on, must be one of: created_at, updated_at, last_contacted_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Account"},"type":"array"}}}}},"summary":"List accounts","tags":["Accounts"]},"post":{"description":"Creates an account.\n\n\"domain\" must be unique on the current team.\n","requestBody":{"$ref":"#/components/requestBodies/postV2AccountsJson"},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Account"}}}}},"summary":"Create an account","tags":["Accounts"]}},"/v2/accounts/{id}.json":{"delete":{"description":"Deletes an account. This operation is not reversible without contacting support.\nThis operation can be called multiple times successfully.\n\nDeleting an account will remove all connected people from that account.\n","parameters":[{"description":"Account ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The Account has been deleted successfully"}},"summary":"Delete an account","tags":["Accounts"]},"get":{"description":"Fetches an account, by ID only.\n","parameters":[{"description":"Account ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Account"}}}}},"summary":"Fetch an account","tags":["Accounts"]},"put":{"description":"Updates an account.\n\n\"domain\" must be unique on the current team.\n","parameters":[{"description":"Account ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/postV2AccountsJson"},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Account"}}}}},"summary":"Update an existing Account","tags":["Accounts"]}},"/v2/action_details/call_instructions.json":{"get":{"description":"Fetches multiple call instruction records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of call instructions to fetch.","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/CallInstruction"},"type":"array"}}}}},"summary":"List call instructions","tags":["Action Details - Call Instructions"]}},"/v2/action_details/call_instructions/{id}.json":{"get":{"description":"Fetches a call instruction, by ID only.\n","parameters":[{"description":"Call instructions ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CallInstruction"}}}}},"summary":"Fetch a call instructions","tags":["Action Details - Call Instructions"]}},"/v2/actions.json":{"get":{"description":"Fetches multiple action records. The records can be filtered, paged, and sorted according to\nthe respective parameters. Only actions that are currently \"in_progess\" will be returned by\nthis endpoint.\n","parameters":[{"description":"IDs of actions to fetch.","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Fetch actions by step ID","in":"query","name":"step_id","required":false,"schema":{"type":"integer"}},{"description":"Filter actions by type","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"Equality filters that are applied to the due_on field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"due_on","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Action"},"type":"array"}}}}},"summary":"List actions","tags":["Actions"]}},"/v2/actions/{id}.json":{"get":{"description":"Fetches an action, by ID only.\nThis endpoint will only return actions that are in_progress or pending_activity.\nOnce an action is complete, the request for that action will return a 404 status code.\n","parameters":[{"description":"Action ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Action"}}}}},"summary":"Fetch an action","tags":["Actions"]}},"/v2/activities/calls.json":{"get":{"description":"Fetches multiple call records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of calls to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Call"},"type":"array"}}}}},"summary":"List calls","tags":["Calls"]}},"/v2/activities/calls/{id}.json":{"get":{"description":"Fetches a call, by ID only.\n","parameters":[{"description":"Call ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Call"}}}}},"summary":"Fetch a call","tags":["Calls"]}},"/v2/activities/emails.json":{"get":{"description":"Fetches multiple email records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of emails to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Filters emails by whether they have bounced or not","in":"query","name":"bounced","required":false,"schema":{"type":"boolean"}},{"description":"Key to sort on, must be one of: updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Email"},"type":"array"}}}}},"summary":"List emails","tags":["Emails"]}},"/v2/activities/emails/{id}.json":{"get":{"description":"Fetches an email, by ID only.\n","parameters":[{"description":"Email ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Email"}}}}},"summary":"Fetch an email","tags":["Emails"]}},"/v2/cadence_memberships.json":{"get":{"description":"Fetches multiple cadence membership records. The records can be filtered, paged, and sorted according to\nthe respective parameters. A cadence membership is the association between a person and their current and\nhistorical time on a cadence. Cadence membership records are mutable and change over time. If a person is\nadded to a cadence and re-added to the same cadence in the future, there is a single membership record.\n","parameters":[{"description":"IDs of cadence memberships to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"ID of the person to find cadence memberships for","in":"query","name":"person_id","required":false,"schema":{"type":"integer"}},{"description":"ID of the cadence to find cadence memberships for","in":"query","name":"cadence_id","required":false,"schema":{"type":"integer"}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Key to sort on, must be one of: updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/CadenceMembership"},"type":"array"}}}}},"summary":"List cadence memberships","tags":["Cadence Memberships"]},"post":{"description":"Adds a person to a cadence. person_id and cadence_id are required, and must be visible to the authenticated user. user_id will\ndefault to the authenticated user, but can be set to any visible user on the authenticated team.\n\nA person cannot be added to a cadence on behalf of a teammate unless the cadence is a team cadence, or the cadence is owned by\nthe teammate.\n","parameters":[{"description":"ID of the person to create a cadence membership for","in":"query","name":"person_id","required":true,"schema":{"type":"integer"}},{"description":"ID of the cadence to create a cadence membership for","in":"query","name":"cadence_id","required":true,"schema":{"type":"integer"}},{"description":"ID of the user to create a cadence membership for. The associated cadence must be owned by the user, or it must be a team cadence","in":"query","name":"user_id","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CadenceMembership"}}}}},"summary":"Create a cadence membership","tags":["Cadence Memberships"]}},"/v2/cadence_memberships/{id}.json":{"delete":{"parameters":[{"description":"CadenceMembership ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The person has been removed from the cadence successfully"}},"summary":"Delete a cadence membership","tags":["Cadence Memberships"]},"get":{"description":"Fetches a cadence membership, by ID only.\n","parameters":[{"description":"CadenceMembership ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CadenceMembership"}}}}},"summary":"Fetch a cadence membership","tags":["Cadence Memberships"]}},"/v2/cadences.json":{"get":{"description":"Fetches multiple cadence records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of cadences to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Filters cadences by whether they are a team cadence or not","in":"query","name":"team_cadence","required":false,"schema":{"type":"boolean"}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Cadence"},"type":"array"}}}}},"summary":"List cadences","tags":["Cadences"]}},"/v2/cadences/{id}.json":{"get":{"description":"Fetches a cadence, by ID only.\n","parameters":[{"description":"Cadence ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Cadence"}}}}},"summary":"Fetch a cadence","tags":["Cadences"]}},"/v2/call_data_records.json":{"get":{"description":"Fetches multiple call data records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n\nCall data records are records of all inbound and outbound calls through SalesLoft. A call data record may\nbe associated with a call, but does not have to be.\n","parameters":[{"description":"IDs of call data records to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Return only call data records which have or do not have a call logged for them","in":"query","name":"has_call","required":false,"schema":{"type":"boolean"}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/CallDataRecord"},"type":"array"}}}}},"summary":"List call data records","tags":["Call Data Records"]}},"/v2/call_data_records/{id}.json":{"get":{"description":"Fetches a call data record, by ID only.\n","parameters":[{"description":"CallDataRecord ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CallDataRecord"}}}}},"summary":"Fetch a call data record","tags":["Call Data Records"]}},"/v2/crm_activities.json":{"get":{"description":"Fetches multiple crm activity records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of crm activities to fetch.","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/CrmActivity"},"type":"array"}}}}},"summary":"List crm activities","tags":["CRM Activities"]}},"/v2/crm_activities/{id}.json":{"get":{"description":"Fetches a crm activity, by ID only.\n","parameters":[{"description":"Crm activity ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CrmActivity"}}}}},"summary":"Fetch a crm activity","tags":["CRM Activities"]}},"/v2/custom_fields.json":{"get":{"description":"Fetches multiple custom field records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of custom fields to fetch.","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Type of field to fetch. Value must be one of: person, company, opportunity","in":"query","name":"field_type","required":false,"schema":{"type":"string"}},{"description":"Key to sort on, must be one of: created_at, updated_at, name. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/CustomField"},"type":"array"}}}}},"summary":"List custom fields","tags":["Custom Fields"]},"post":{"description":"Creates a custom field.\n","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"description":"The name of the custom field","type":"string"},"field_type":{"description":"The field type of the custom field. Value must be one of: person, company, opportunity","type":"string"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CustomField"}}}}},"summary":"Create a custom field","tags":["Custom Fields"]}},"/v2/custom_fields/{id}.json":{"delete":{"description":"Deletes a custom field.\n","parameters":[{"description":"Custom Field ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The Custom Field has been deleted successfully"}},"summary":"Delete a custom field","tags":["Custom Fields"]},"get":{"description":"Fetches a custom field, by ID only.\n","parameters":[{"description":"Custom Field ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CustomField"}}}}},"summary":"Fetch a custom field","tags":["Custom Fields"]},"put":{"description":"Update a custom field.\n","parameters":[{"description":"Custom Field ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"description":"The name of the custom field","type":"string"},"field_type":{"description":"The field type of the custom field. Value must be one of: person, company, opportunity","type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CustomField"}}}}},"summary":"Update a custom field","tags":["Custom Fields"]}},"/v2/email_templates.json":{"get":{"description":"Fetches multiple email template records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of email templates to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Filters email templates by whether they are linked to a team template or not","in":"query","name":"linked_to_team_template","required":false,"schema":{"type":"boolean"}},{"description":"Key to sort on, must be one of: created_at, updated_at, last_used_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/EmailTemplate"},"type":"array"}}}}},"summary":"List email templates","tags":["Email Templates"]}},"/v2/email_templates/{id}.json":{"get":{"description":"Fetches an email template, by ID only.\n","parameters":[{"description":"EmailTemplate ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EmailTemplate"}}}}},"summary":"Fetch an email template","tags":["Email Templates"]}},"/v2/imports.json":{"get":{"description":"Fetches multiple imports.\n","parameters":[{"description":"IDs of imports to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"ID of users to fetch imports for. Using this filter will return an empty array for non-admin users who request other user's imports","in":"query","name":"user_ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to created_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Import"},"type":"array"}}}}},"summary":"List imports","tags":["Imports"]},"post":{"description":"Creates an import.\n","requestBody":{"$ref":"#/components/requestBodies/postV2ImportsJson"},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Import"}}}}},"summary":"Create an import","tags":["Imports"]}},"/v2/imports/{id}.json":{"delete":{"description":"Deletes an import, by ID only. The associated people can be deleted as part of the deletion process.\n\nAdmin users can access imports for the entire team, but non-admin users can only access their own imports.\n","parameters":[{"description":"Import ID","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Whether to delete people on this Import. Possible values are: [not present], all, single.\n\n'single' will delete people who are only present in this Import.\n'all' will delete people even if they are present in other Imports.\nNot specifying this parameter will not delete any people\n","in":"query","name":"undo","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"The import has been deleted successfully"}},"summary":"Delete an import","tags":["Imports"]},"get":{"description":"Fetches an import, by ID only.\n\nAdmin users can access imports for the entire team, but non-admin users can only access their own imports.\n","parameters":[{"description":"Import ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Import"}}}}},"summary":"Fetch an import","tags":["Imports"]},"put":{"description":"Updates an import, by ID only.\n\nAdmin users can access imports for the entire team, but non-admin users can only access their own imports.\n","parameters":[{"description":"Import ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/postV2ImportsJson"},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Import"}}}}},"summary":"Update an import","tags":["Imports"]}},"/v2/me.json":{"get":{"description":"Authenticated user information. This endpoint does not accept any parameters as it is\nrepresents your authenticated user. The \"Users\" resource provides user information\nfor other users on the team.\n","responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/User"}}}}},"summary":"Fetch current user","tags":["Me"]}},"/v2/notes.json":{"get":{"description":"Fetches multiple note records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"Case insensitive type of item with which the note is associated. Value must be one of: person, account","in":"query","name":"associated_with_type","required":false,"schema":{"type":"string"}},{"description":"ID of the item with which the note is associated. The associated_with_type must also be present if this parameter is used","in":"query","name":"associated_with_id","required":false,"schema":{"type":"integer"}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"IDs of notes to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Note"},"type":"array"}}}}},"summary":"List notes","tags":["Notes"]},"post":{"description":"Creates a note.\n","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"content":{"description":"The content of the note","type":"string"},"associated_with_type":{"description":"Case insensitive type of item with which the note is associated. Value must be one of: person, account","type":"string"},"associated_with_id":{"description":"ID of the item with which the note is associated","type":"integer"},"skip_crm_sync":{"description":"Boolean indicating if the CRM sync should be skipped. No syncing will occur if true","type":"boolean"},"call_id":{"description":"ID of the call with which the note is associated. The call cannot already have a note","type":"integer"}},"required":["content","associated_with_type","associated_with_id"]}}}},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Note"}}}}},"summary":"Create a note","tags":["Notes"]}},"/v2/notes/{id}.json":{"get":{"description":"Fetches a note, by ID only.\n","parameters":[{"description":"Note ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Note"}}}}},"summary":"Fetch a note","tags":["Notes"]},"put":{"description":"Updates a note. Any changes to the note or associated records will not reflect in Salesforce.com.\n","parameters":[{"description":"Note ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"content":{"description":"The content of the note","type":"string"},"call_id":{"description":"ID of the call with which the note is associated. The call cannot already have a note. If the note is associated to a call already, it will become associated to the requested call","type":"integer"}},"required":["content"]}}}},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Person"}}}}},"summary":"Update a note","tags":["Notes"]}},"/v2/people.json":{"get":{"description":"Fetches multiple person records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of people to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Filters people by email address","in":"query","name":"email_addresses","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Key to sort on, must be one of: created_at, updated_at, last_contacted_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Person"},"type":"array"}}}}},"summary":"List people","tags":["People"]},"post":{"description":"Creates a person. Either email_address or phone/last_name must be provided as a unique lookup\non the team.\n","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"email_address":{"description":"Email address","type":"string"},"secondary_email_address":{"description":"Alternate email address","type":"string"},"personal_email_address":{"description":"Personal email address","type":"string"},"first_name":{"description":"First name","type":"string"},"last_name":{"description":"Last name","type":"string"},"phone":{"description":"Phone without formatting","type":"string"},"phone_extension":{"description":"Phone extension without formatting","type":"string"},"mobile_phone":{"description":"Mobile phone without formatting","type":"string"},"home_phone":{"description":"Home phone without formatting","type":"string"},"linkedin_url":{"description":"Linkedin URL","type":"string"},"title":{"description":"Job title","type":"string"},"city":{"description":"City","type":"string"},"state":{"description":"State","type":"string"},"country":{"description":"Country","type":"string"},"work_city":{"description":"Work location - city","type":"string"},"work_state":{"description":"Work location - state","type":"string"},"work_country":{"description":"Work location - country","type":"string"},"person_company_name":{"description":"Company name. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended","type":"string"},"person_company_website":{"description":"Company website. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended","type":"string"},"person_company_industry":{"description":"Company industry. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended","type":"string"},"do_not_contact":{"description":"Whether this person can not be contacted. Values are either true or false. Setting this to true will remove the person from all active communications","type":"boolean"},"locale":{"description":"Time locale of the person","type":"string"},"personal_website":{"description":"The website of this person","type":"string"},"twitter_handle":{"description":"The twitter handle of this person","type":"string"},"tags":{"description":"All tags applied to this person","type":"array","items":{"type":"string"}},"custom_fields":{"description":"Custom fields are defined by the user's team. Only fields with values are presented in the API.","type":"array","items":{"type":"string"}},"account_id":{"description":"ID of the Account to link this person to","type":"integer"},"owner_id":{"description":"ID of the User that owns this person","type":"integer"},"import_id":{"description":"ID of the Import this person is a part of. A person can be part of multiple imports, but this ID will always be the most recent Import","type":"integer"},"person_stage_id":{"description":"ID of the PersonStage of this person","type":"integer"},"autotag_date":{"description":"Whether the date should be added to this person as a tag. Default is false. The tag will be Y-m-d format.","type":"boolean"}}}}}},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Person"}}}}},"summary":"Create a person","tags":["People"]}},"/v2/people/{id}.json":{"delete":{"description":"Deletes a person. This operation is not reversible without contacting support.\nThis operation can be called multiple times successfully.\n","parameters":[{"description":"Person id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The person has been deleted successfully"}},"summary":"Delete a person","tags":["People"]},"get":{"description":"Fetches a person, by ID only.\n","parameters":[{"description":"Person ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Person"}}}}},"summary":"Fetch a person","tags":["People"]},"put":{"description":"Updates a person.\n","parameters":[{"description":"Person id","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"email_address":{"description":"Email address","type":"string"},"secondary_email_address":{"description":"Alternate email address","type":"string"},"personal_email_address":{"description":"Personal email address","type":"string"},"first_name":{"description":"First name","type":"string"},"last_name":{"description":"Last name","type":"string"},"phone":{"description":"Phone without formatting","type":"string"},"phone_extension":{"description":"Phone extension without formatting","type":"string"},"mobile_phone":{"description":"Mobile phone without formatting","type":"string"},"home_phone":{"description":"Home phone without formatting","type":"string"},"linkedin_url":{"description":"Linkedin URL","type":"string"},"title":{"description":"Job title","type":"string"},"city":{"description":"City","type":"string"},"state":{"description":"State","type":"string"},"country":{"description":"Country","type":"string"},"work_city":{"description":"Work location - city","type":"string"},"work_state":{"description":"Work location - state","type":"string"},"work_country":{"description":"Work location - country","type":"string"},"person_company_name":{"description":"Company name. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended","type":"string"},"person_company_website":{"description":"Company website. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended","type":"string"},"person_company_industry":{"description":"Company industry. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended","type":"string"},"do_not_contact":{"description":"Whether this person can not be contacted. Values are either true or false. Setting this to true will remove the person from all active communications","type":"boolean"},"locale":{"description":"Time locale of the person","type":"string"},"personal_website":{"description":"The website of this person","type":"string"},"twitter_handle":{"description":"The twitter handle of this person","type":"string"},"tags":{"description":"All tags applied to this person","type":"array","items":{"type":"string"}},"custom_fields":{"description":"Custom fields are defined by the user's team. Only fields with values are presented in the API.","type":"array","items":{"type":"string"}},"account_id":{"description":"ID of the Account to link this person to","type":"integer"},"owner_id":{"description":"ID of the User that owns this person","type":"integer"},"import_id":{"description":"ID of the Import this person is a part of. A person can be part of multiple imports, but this ID will always be the most recent Import","type":"integer"},"person_stage_id":{"description":"ID of the PersonStage of this person","type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Person"}}}}},"summary":"Update a person","tags":["People"]}},"/v2/person_stages.json":{"get":{"description":"Fetches multiple person stage records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of person stages to fetch.","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/PersonStage"},"type":"array"}}}}},"summary":"List person stages","tags":["Person Stages"]},"post":{"description":"Creates a person stage.\n","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"description":"The name of the new stage","type":"string"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonStage"}}}}},"summary":"Create a person stage","tags":["Person Stages"]}},"/v2/person_stages/{id}.json":{"delete":{"description":"Deletes a person stage. This operation is not reversible without contacting support.\nThis operation can be called multiple times successfully.\n","parameters":[{"description":"Stage ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The Person Stage has been deleted successfully"}},"summary":"Delete an person stage","tags":["Person Stages"]},"get":{"description":"Fetches a person stage, by ID only.\n","parameters":[{"description":"Stage ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonStage"}}}}},"summary":"Fetch a person stage","tags":["Person Stages"]},"put":{"description":"Updates a person stage.\n","parameters":[{"description":"Stage ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"description":"The name of the stage.","type":"string"}},"required":["name"]}}}},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonStage"}}}}},"summary":"Update a person stage","tags":["Person Stages"]}},"/v2/phone_numbers/caller_ids.json":{"get":{"description":"Each entry is a possible caller ID match for the number. Multiple\nentries may be returned if the phone number is present on more than one\nperson in the system. Phone number should be in E.164 format.\n","parameters":[{"description":"E.164 Phone Number","in":"query","name":"phone_number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/CallerId"},"type":"array"}}}}},"summary":"List caller ids","tags":["Caller IDs"]}},"/v2/phone_numbers/recording_settings/{id}.json":{"get":{"description":"Fetches the recording status for a given phone number, based on Do Not Record and Recording Governance for your team.\nPhone number should be in E.164 format.\n","parameters":[{"description":"E.164 Phone Number","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RecordingSetting"}}}}},"summary":"Fetch recording setting","tags":["Recording Settings"]}},"/v2/steps.json":{"get":{"description":"Fetches multiple step records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of steps to fetch.","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Filter by cadence ID","in":"query","name":"cadence_id","required":false,"schema":{"type":"integer"}},{"description":"Filter by step type","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"Filter by whether a step has due actions","in":"query","name":"has_due_actions","required":false,"schema":{"type":"boolean"}},{"description":"Key to sort on, must be one of: created_at, updated_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Step"},"type":"array"}}}}},"summary":"List steps","tags":["Steps"]}},"/v2/steps/{id}.json":{"get":{"description":"Fetches a step, by ID only.\n","parameters":[{"description":"Step ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Step"}}}}},"summary":"Fetch a step","tags":["Steps"]}},"/v2/successes.json":{"get":{"description":"Fetches multiple success records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n","parameters":[{"description":"IDs of successes to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Key to sort on, must be one of: created_at, updated_at, succeeded_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/Success"},"type":"array"}}}}},"summary":"List successes","tags":["Successes"]}},"/v2/team.json":{"get":{"description":"Fetches the team of the authenticated user.\n","responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Team"}}}}},"summary":"Fetch current team","tags":["Team"]}},"/v2/team_templates.json":{"get":{"description":"Fetches multiple team template records. The records can be filtered, paged, and sorted according to\nthe respective parameters.\n\nTeam templates are templates that are available team-wide. Admins may use\nteam templates to create original content for the entire team, monitor version control to ensure templates are always up to date,\nand track template performance across the entire organization. All metrics on a team template reflect usage across the team; individual metrics can be found with the email_templates API endpoint.\n","parameters":[{"description":"IDs of team templates to fetch. If a record can't be found, that record won't be returned and your request will be successful","in":"query","name":"ids","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Equality filters that are applied to the updated_at field. A single filter can be used by itself or combined with other filters to create a range.\n---CUSTOM---\n{\"type\":\"object\",\"keys\":[{\"name\":\"gt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"gte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lt\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than the provided iso8601 timestamp. The comparison is done using microsecond precision.\"},{\"name\":\"lte\",\"type\":\"iso8601 string\",\"description\":\"Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.\"}]}\n","in":"query","name":"updated_at","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Key to sort on, must be one of: created_at, updated_at, last_used_at. Defaults to updated_at","in":"query","name":"sort_by","required":false,"schema":{"type":"string"}},{"description":"Direction to sort in, must be one of: ASC, DESC. Defaults to DESC","in":"query","name":"sort_direction","required":false,"schema":{"type":"string"}},{"description":"How many records to show per page in the range [1, 100]. Defaults to 25","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"The current page to fetch results from. Defaults to 1","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"Whether to include total_pages and total_count in the metadata. Defaults to false","in":"query","name":"include_paging_counts","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/TeamTemplate"},"type":"array"}}}}},"summary":"List team templates","tags":["Team Templates"]}},"/v2/team_templates/{id}.json":{"get":{"description":"Fetches a team template, by ID only.\n","parameters":[{"description":"Team Template ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TeamTemplate"}}}}},"summary":"Fetch a team template","tags":["Team Templates"]}},"/v2/users.json":{"get":{"description":"Non Admin: Lists only your user, or all on team depending on group visibility policy\nTeam Admin: Lists users associated with your team\n","responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/User"},"type":"array"}}}}},"summary":"List users","tags":["Users"]}},"/v2/users/{id}.json":{"get":{"description":"Fetches a user, by ID only.\n","parameters":[{"description":"User ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/User"}}}}},"summary":"Fetch a user","tags":["Users"]}}},"servers":[{"url":"https://api.salesloft.com"}],"components":{"requestBodies":{"postV2AccountsJson":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"description":"Account Full Name","type":"string"},"domain":{"description":"Website domain, not a fully qualified URI","type":"string"},"conversational_name":{"description":"Conversational name of the Account","type":"string"},"description":{"description":"Description","type":"string"},"phone":{"description":"Phone number without formatting","type":"string"},"website":{"description":"Website","type":"string"},"linkedin_url":{"description":"Full LinkedIn url","type":"string"},"twitter_handle":{"description":"Twitter handle, with @","type":"string"},"street":{"description":"Street name and number","type":"string"},"city":{"description":"City","type":"string"},"state":{"description":"State","type":"string"},"postal_code":{"description":"Postal code","type":"string"},"country":{"description":"Country","type":"string"},"locale":{"description":"Time locale","type":"string"},"industry":{"description":"Industry","type":"string"},"company_type":{"description":"Type of the Account's company","type":"string"},"founded":{"description":"Date or year of founding","type":"string"},"revenue_range":{"description":"Estimated revenue range","type":"string"},"size":{"description":"Estimated number of people in employment","type":"string"},"do_not_contact":{"description":"Whether this company can not be contacted. Values are either true or false. Setting this to true will remove all associated people from all active communications","type":"boolean"},"custom_fields":{"description":"Custom fields are defined by the user's team. Only fields with values are presented in the API.","type":"array","items":{"type":"string"}},"tags":{"description":"All tags applied to this Account","type":"array","items":{"type":"string"}},"owner_id":{"description":"ID of the User that owns this Account","type":"integer"},"company_stage_id":{"description":"ID of the CompanyStage assigned to this Account","type":"integer"}},"required":["name","domain"]}}}},"postV2ImportsJson":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"user_id":{"description":"ID of the User that owns this Import","type":"integer"},"name":{"description":"Name, recommended to be easily identifiable to a user","type":"string"}}}}}}},"securitySchemes":{"OAuth2":{"type":"oauth2","x-authorizationUrl":"https://accounts.salesloft.com/oauth/authorize","flows":{"clientCredentials":{"tokenUrl":"https://accounts.salesloft.com/oauth/token","scopes":{}}}}},"schemas":{"Account":{"properties":{"archived_at":{"description":"Datetime of when the Account was archived, if archived","example":"2018-02-01T15:02:39.396392-05:00","format":"date","type":"string"},"city":{"description":"City","example":"Dufftown","type":"string"},"company_stage":{"$ref":"#/components/schemas/EmbeddedResource"},"company_type":{"description":"Type of the Account's company","example":"Private","type":"string"},"conversational_name":{"description":"Conversational name of the Account","example":"Hogwarts","type":"string"},"country":{"description":"Country","example":"Scotland","type":"string"},"counts":{"$ref":"#/components/schemas/AccountCounts"},"created_at":{"description":"Datetime of when the Account was created","example":"2018-02-01T15:02:39.396254-05:00","format":"date","type":"string"},"creator":{"$ref":"#/components/schemas/EmbeddedResource"},"crm_id":{"description":"CRM ID, currently Salesforce.com only","example":"003i000001mnhpD","type":"string"},"crm_object_type":{"description":"CRM object type, currently Salesforce.com only","example":"account","type":"string"},"crm_url":{"description":"CRM url, currently Salesforce.com only","example":"https://na15.salesforce.com/003i000001mnhpD","type":"string"},"custom_fields":{"description":"Custom fields are defined by the user's team. Only fields with values are presented in the API.","example":{"MyField":"A Value","Other":"Field"},"type":"object"},"description":{"description":"Description","example":"British school of magic for students","type":"string"},"do_not_contact":{"description":"Whether this company has opted out of communications. Do not contact someone at this company when this is set to true","example":true,"type":"boolean"},"domain":{"description":"Website domain, not a fully qualified URI","example":"salesloft.com","type":"string"},"founded":{"description":"Date or year of founding","example":"March 1st, 1820","type":"string"},"id":{"description":"ID of Account","example":1,"type":"integer"},"industry":{"description":"Industry","example":"Education","type":"string"},"last_contacted_at":{"description":"Datetime this Account was last contacted","example":"2018-02-01T15:02:39.397020-05:00","format":"date","type":"string"},"last_contacted_by":{"$ref":"#/components/schemas/EmbeddedResource"},"last_contacted_person":{"$ref":"#/components/schemas/EmbeddedResource"},"last_contacted_type":{"description":"The type of the last touch to this Account. Can be call, email, other","example":"call","type":"string"},"linkedin_url":{"description":"Full LinkedIn url","example":"https://www.linkedin.com/company/2296178/","type":"string"},"locale":{"description":"Time locale","example":"Europe/London","type":"string"},"name":{"description":"Account Full Name","example":"Hogwarts School of Witchcraft and Wizardry","type":"string"},"owner":{"$ref":"#/components/schemas/EmbeddedResource"},"owner_crm_id":{"description":"Mapped owner field from the CRM, currently Salesforce.com only","example":"003i000001mnhpD","type":"string"},"phone":{"description":"Phone number without formatting","example":"+1 444 555 6666","type":"string"},"postal_code":{"description":"Postal code","example":"55555","type":"string"},"revenue_range":{"description":"Estimated revenue range","example":"1,000,000-2,000,000","type":"string"},"size":{"description":"Estimated number of people in employment","example":"1500","type":"string"},"state":{"description":"State","example":"Mortlach","type":"string"},"street":{"description":"Street name and number","example":"4 Picket Drive","type":"string"},"tags":{"description":"All tags applied to this Account","example":["7-23-2017","dreamforce"],"items":{"type":"string"},"type":"array"},"twitter_handle":{"description":"Twitter handle, with @","example":"@kyleporter","type":"string"},"updated_at":{"description":"Datetime of when the Account was last updated","example":"2018-02-01T15:02:39.396329-05:00","format":"date","type":"string"},"website":{"description":"Website","example":"https://salesloft.com","type":"string"}}},"AccountCounts":{"properties":{"people":{"description":"Number of people in SalesLoft associated with this Account","example":15,"type":"integer"}}},"Action":{"properties":{"action_details":{"$ref":"#/components/schemas/EmbeddedResource"},"created_at":{"description":"Datetime of when the Action was created","example":"2018-02-01T00:00:00.000000-05:00","format":"date","type":"string"},"due":{"description":"Whether this step is due","example":true,"type":"boolean"},"due_on":{"description":"When action is due","example":"2018-02-01T15:02:39.560063-05:00","format":"date","type":"string"},"id":{"description":"ID of Action","example":1,"type":"integer"},"person":{"$ref":"#/components/schemas/EmbeddedResource"},"status":{"description":"The current state of the person on the cadence. Possible values are:\n\nin_progress: this action has not been completed\n\npending_activity: this action has been acted upon, but the action has not been completed.\n(i.e. the email is scheduled to send, but has not been delivered yet)\n","example":"in_progress","type":"string"},"type":{"description":"The type of this action. Valid types are: email, phone, other. New types may be added in the future.\n","example":"phone","type":"string"},"updated_at":{"description":"Datetime of when the Action was last updated","example":"2018-02-01T15:02:39.559930-05:00","format":"date","type":"string"},"user":{"$ref":"#/components/schemas/EmbeddedResource"}}},"Cadence":{"properties":{"added_stage":{"$ref":"#/components/schemas/EmbeddedResource"},"archived_at":{"description":"Datetime of when the cadence was archived, if archived","example":"2018-02-01T15:02:39.419122-05:00","format":"date","type":"string"},"bounced_stage":{"$ref":"#/components/schemas/EmbeddedResource"},"counts":{"$ref":"#/components/schemas/CadenceCounts"},"created_at":{"description":"Datetime of when the cadence was created","example":"2018-02-01T15:02:39.419014-05:00","format":"date","type":"string"},"creator":{"$ref":"#/components/schemas/EmbeddedResource"},"finished_stage":{"$ref":"#/components/schemas/EmbeddedResource"},"id":{"description":"ID of cadence","example":1,"type":"integer"},"name":{"description":"Cadence name","example":"Prospecting - VP of Sales","type":"string"},"opt_out_link_included":{"description":"Whether this cadence is configured to include an opt-out link by default","example":true,"type":"boolean"},"owner":{"$ref":"#/components/schemas/EmbeddedResource"},"remove_bounces_enabled":{"description":"Whether this cadence is configured to automatically remove people who have bounced","example":true,"type":"boolean"},"remove_replies_enabled":{"description":"Whether this cadence is configured to automatically remove people who have replied","example":true,"type":"boolean"},"replied_stage":{"$ref":"#/components/schemas/EmbeddedResource"},"shared":{"description":"Whether this cadence is visible to team members (shared)","example":false,"type":"boolean"},"tags":{"description":"All tags applied to this cadence","example":["7-23-2017","dreamforce"],"items":{"type":"string"},"type":"array"},"team_cadence":{"description":"Whether this cadence is a team cadence. A team cadence is created by an admin and can be run by all users","example":false,"type":"boolean"},"updated_at":{"description":"Datetime of when the cadence was last updated","example":"2018-02-01T15:02:39.419082-05:00","format":"date","type":"string"}}},"CadenceCounts":{"properties":{"cadence_people":{"description":"The number of people that have ever been added to the cadence","example":59,"type":"integer"},"target_daily_people":{"description":"The user defined target for number of people to add to the cadence each day","example":10,"type":"integer"}}},"CadenceMembership":{"properties":{"added_at":{"description":"Datetime of when the person was last added to this cadence","example":"2018-02-01T15:02:39.409933-05:00","format":"date","type":"string"},"cadence":{"$ref":"#/components/schemas/EmbeddedResource"},"counts":{"$ref":"#/components/schemas/CadenceMembershipCounts"},"created_at":{"description":"Datetime of when the person was first added to this cadence","example":"2018-02-01T15:02:39.409985-05:00","format":"date","type":"string"},"current_state":{"description":"The current state of the person on the cadence. Possible values are:\n\nstaged: The person is waiting for the first step in the cadence to occur\n\nactive: The cadence has begun processing this person and is still in the process, but idle\n\nscheduled: The cadence has begun processing this person and is still in the process, with an activity scheduled to occur\n\ncompleted: The cadence has been completed for this person\n\nremoved: The person was manually or automatically removed from the cadence\n\nremoved_no_action: The person was removed from the cadence before any action occurred\n\nreassigned: The person's cadence execution was transferred to a different user, ending this user's interaction\n","example":"staged","type":"string"},"id":{"description":"Cadence membership ID","example":1,"type":"integer"},"latest_action":{"$ref":"#/components/schemas/EmbeddedResource"},"person":{"$ref":"#/components/schemas/EmbeddedResource"},"person_deleted":{"description":"Whether the associated person has since been deleted","example":false,"type":"boolean"},"updated_at":{"description":"Datetime of when the record was last updated","example":"2018-02-01T15:02:39.410015-05:00","format":"date","type":"string"},"user":{"$ref":"#/components/schemas/EmbeddedResource"}}},"CadenceMembershipCounts":{"properties":{"bounces":{"description":"The number of times emails sent from the cadence to the person bounced","example":0,"type":"integer"},"calls":{"description":"The number of times a call was logged from the cadence to the person","example":2,"type":"integer"},"clicks":{"description":"The number of times emails sent from the cadence to the person were clicked","example":5,"type":"integer"},"replies":{"description":"The number of times emails sent from the cadence to the person were replied to","example":2,"type":"integer"},"sent_emails":{"description":"The number of times emails were sent from the cadence to the person","example":4,"type":"integer"},"views":{"description":"The number of times emails sent from the cadence to the person were opened","example":10,"type":"integer"}}},"Call":{"properties":{"action":{"$ref":"#/components/schemas/EmbeddedResource"},"called_person":{"$ref":"#/components/schemas/EmbeddedResource"},"created_at":{"description":"Datetime of when the call was created","example":"2018-02-01T15:02:39.523939-05:00","format":"date","type":"string"},"crm_activity":{"$ref":"#/components/schemas/EmbeddedResource"},"disposition":{"description":"Result of the call","example":"Connected","type":"string"},"duration":{"description":"Length of the call in seconds","example":60,"type":"integer"},"id":{"description":"ID of Call","example":1,"type":"integer"},"note":{"$ref":"#/components/schemas/EmbeddedResource"},"recordings":{"description":"The recordings for this this call and their status","example":[{"status":"completed","url":"https://example.com/recording1"}],"items":{"$ref":"#/components/schemas/EmbeddedRecordingResource"},"type":"array"},"sentiment":{"description":"Outcome of the conversation","example":"Demo Scheduled","type":"string"},"to":{"description":"Phone number that received the call","example":"7705551234","type":"string"},"updated_at":{"description":"Datetime of when the call was last updated","example":"2018-02-01T15:02:39.524003-05:00","format":"date","type":"string"},"user":{"$ref":"#/components/schemas/EmbeddedResource"}}},"CallDataRecord":{"properties":{"call":{"$ref":"#/components/schemas/EmbeddedResource"},"created_at":{"description":"Datetime of when the call was created","example":"2018-02-01T15:02:39.425319-05:00","format":"date","type":"string"},"direction":{"description":"Direction of the call. Can be one of: inbound, outbound","example":"outbound","type":"string"},"duration":{"description":"Length of the call in seconds","example":60,"type":"integer"},"from":{"description":"Phone number that placed the call","example":"7705551234","type":"string"},"id":{"description":"ID of CallDataRecord","example":1,"type":"integer"},"recording":{"$ref":"#/components/schemas/EmbeddedRecordingResource"},"to":{"description":"Phone number that received the call","example":"7705551234","type":"string"},"updated_at":{"description":"Datetime of when the call was last updated","example":"2018-02-01T15:02:39.425365-05:00","format":"date","type":"string"},"user":{"$ref":"#/components/schemas/EmbeddedResource"}}},"CallInstruction":{"properties":{"created_at":{"description":"Datetime of when the call instructions were created","example":"2018-02-01T15:02:39.571365-05:00","format":"date","type":"string"},"id":{"description":"ID of call instructions","example":1,"type":"integer"},"instructions":{"description":"The instructions","example":"Call once, leave voicemail if not answered. Conference conversation.","type":"string"},"updated_at":{"description":"Datetime of when the call instructions were last updated","example":"2018-02-01T15:02:39.571468-05:00","format":"date","type":"string"}}},"CallerId":{"properties":{"account_name":{"description":"The account of the person calling","example":"Bunty Soap Company","type":"string"},"display_name":{"description":"The name of the person calling","example":"Frank Galikanokus","type":"string"},"person":{"$ref":"#/components/schemas/EmbeddedResource"},"title":{"description":"The title of the person calling","example":"Transportation Coordinator","type":"string"}}},"CrmActivity":{"properties":{"activity_type":{"description":"The type of activity that is being recorded, if available. The values can change over time, but could be one of: email, phone, email reminder, inmail","example":"phone","type":"string"},"created_at":{"description":"Datetime of when the crm activity was created","example":"2018-02-01T15:02:39.431249-05:00","format":"date","type":"string"},"crm_id":{"description":"The ID of the activity in Salesforce, if written to Salesforce","example":"00T0H00003w2FBhUAM","type":"string"},"custom_crm_fields":{"description":"Additional fields that are logged to Salesforce, if mapped by the team at the time of writing to Salesforce","example":{"ecorp__Call_Type__c":"inbound follow up"},"type":"object"},"description":{"description":"The description field of the activity in Salesforce","example":"Timeline is 2 weeks for demo, set with Kate","type":"string"},"error":{"description":"Information about why this crm activity failed to sync, if it did fail to sync. Failed activities will be automatically retried and may become successful in the future","type":"string"},"id":{"description":"CrmActivity ID","example":1,"type":"integer"},"person":{"$ref":"#/components/schemas/EmbeddedResource"},"subject":{"description":"The subject field of the activity in Salesforce","example":"Call: Connected | Interested","type":"string"},"updated_at":{"description":"Datetime of when the crm activity was last updated","example":"2018-02-01T15:02:39.431293-05:00","format":"date","type":"string"},"user":{"$ref":"#/components/schemas/EmbeddedResource"}}},"CustomField":{"properties":{"created_at":{"description":"Datetime of when the Custom Field was created","example":"2018-02-01T15:02:39.436288-05:00","format":"date","type":"string"},"field_type":{"description":"Type of the Custom Field. Value must be one of: person, company, opportunity.","example":"person","type":"string"},"id":{"description":"ID of Custom Field","example":1,"type":"integer"},"name":{"description":"Name of the Custom Field","example":"My Custom Field","type":"string"},"updated_at":{"description":"Datetime of when the Custom Field was last updated","example":"2018-02-01T15:02:39.436326-05:00","format":"date","type":"string"}}},"Email":{"properties":{"action":{"$ref":"#/components/schemas/EmbeddedResource"},"bounced":{"description":"Whether this email bounced","example":false,"type":"boolean"},"click_tracking":{"description":"Whether this email had click tracking enabled","example":true,"type":"boolean"},"counts":{"$ref":"#/components/schemas/EmailCounts"},"created_at":{"description":"Datetime of when the email was created","example":"2018-02-01T15:02:39.530887-05:00","format":"date","type":"string"},"crm_activity":{"$ref":"#/components/schemas/EmbeddedResource"},"headers":{"description":"Selected headers that are included if this email used them. Available keys are: cc, bcc","example":{"bcc":"track@salesforce.com","cc":"sb@salesloft.com"},"type":"object"},"id":{"description":"ID of Email","example":1,"type":"integer"},"mailing":{"$ref":"#/components/schemas/EmbeddedResource"},"recipient":{"$ref":"#/components/schemas/EmbeddedResource"},"recipient_email_address":{"description":"Email address of the recipient","example":"bob.smith@example.com","type":"string"},"send_after":{"description":"When this email will be sent, or null if already sent","example":"2018-02-01T15:02:39.543784-05:00","format":"date","type":"string"},"sent_at":{"description":"When this email was sent, or null if it was not sent","example":"2018-02-01T15:02:39.543843-05:00","format":"date","type":"string"},"status":{"description":"Status of this email through the sending process. Possible values are: sent, sent_from_gmail, sent_from_external, pending, pending_reply_check, scheduled, sending, delivering, failed, cancelled, pending_through_gmail, pending_through_external","example":"sent","type":"string"},"updated_at":{"description":"Datetime of when the email was last updated","example":"2018-02-01T15:02:39.530975-05:00","format":"date","type":"string"},"user":{"$ref":"#/components/schemas/EmbeddedResource"},"view_tracking":{"description":"Whether this email had view tracking enabled","example":true,"type":"boolean"}}},"EmailCounts":{"properties":{"attachments":{"description":"The number of attachments on the email","example":0,"type":"integer"},"clicks":{"description":"The number of times links in the email were clicked","example":2,"type":"integer"},"replies":{"description":"The number of replies the email received","example":1,"type":"integer"},"unique_devices":{"description":"The number of unique devices that opened the email","example":4,"type":"integer"},"unique_locations":{"description":"The number of unique locations that opened the email","example":3,"type":"integer"},"views":{"description":"The number of times the email was opened","example":3,"type":"integer"}}},"EmailTemplate":{"properties":{"archived_at":{"description":"Datetime of when the email template was archived, if archived","example":"2018-02-01T15:02:39.443876-05:00","format":"date","type":"string"},"body":{"description":"Sanitized body of the email template without email signature","example":"<div><div>Welcome to the SalesLoft family! My name is Sarah and I’m your implementation consultant. I’m here to get you up and running. It's my job to help you configure your team's SalesLoft access, provide customized training for your specific goals, and make sure that you and your team are ready to crush your goals.</div><div dir=\"ltr\"><br></div>Thank you,<br></div>","type":"string"},"cadence_template":{"description":"Whether this email template is only used on a cadence step. These templates are not visible in the SalesLoft application template list. If false, this email template is visible in the SalesLoft application, and may be used when composing an email or creating a cadence step.","example":true,"type":"boolean"},"click_tracking_enabled":{"description":"Whether click tracking is enabled for this email template","example":true,"type":"boolean"},"counts":{"$ref":"#/components/schemas/EmailTemplateCounts"},"created_at":{"description":"Datetime of when the email template was created","example":"2018-02-01T15:02:39.443757-05:00","format":"date","type":"string"},"id":{"description":"ID of email template","example":5,"type":"integer"},"last_used_at":{"description":"Datetime of when the email template was last used","example":"2018-02-01T15:02:39.443850-05:00","format":"date","type":"string"},"open_tracking_enabled":{"description":"Whether open tracking is enabled for this email template","example":true,"type":"boolean"},"shared":{"description":"Whether this email template is visible to team members (shared)","example":false,"type":"boolean"},"subject":{"description":"Subject of the email template","example":"Welcome to SalesLoft!","type":"string"},"team_template":{"$ref":"#/components/schemas/EmbeddedResource"},"template_owner":{"$ref":"#/components/schemas/EmbeddedResource"},"title":{"description":"Title of the email template","example":"Welcome email","type":"string"},"updated_at":{"description":"Datetime of when the email template was last updated","example":"2018-02-01T15:02:39.443798-05:00","format":"date","type":"string"}}},"EmailTemplateCounts":{"properties":{"bounces":{"description":"The number of bounces the email template received","example":10,"type":"integer"},"clicks":{"description":"The number of times links in the email template were clicked","example":20,"type":"integer"},"replies":{"description":"The number of replies the email template received","example":1,"type":"integer"},"sent_emails":{"description":"The number of times the email template was sent out","example":59,"type":"integer"},"views":{"description":"The number of times the email template was opened","example":3,"type":"integer"}}},"EmbeddedRecordingResource":{"properties":{"status":{"description":"The processing status of the recording. A completed status means that the recording is fully available","example":"completed","type":"string"},"url":{"description":"The url of the recording","example":"http://example.com/recording/1","type":"string"}}},"EmbeddedResource":{"properties":{"_href":{"description":"Resource URL, pointed at your API version, present if this resource is available in the API","example":"https://api.salesloft.com/v2/widgets/10","type":"string"},"id":{"description":"ID of the resource","example":10,"type":"integer"}}},"Import":{"properties":{"created_at":{"description":"Datetime of when the import was created","example":"2018-02-01T15:02:39.450608-05:00","format":"date","type":"string"},"current_people_count":{"description":"Count of People that have not been deleted","example":5,"type":"integer"},"id":{"description":"Import ID","example":1,"type":"integer"},"imported_people_count":{"description":"Count of People that have ever been on this Import","example":7,"type":"integer"},"name":{"description":"Name of Import","example":"DataProvider -> SalesLoft 9/1/17","type":"string"},"updated_at":{"description":"Datetime of when the import was last updated, ignoring relationship changes","example":"2018-02-01T15:02:39.450663-05:00","format":"date","type":"string"}}},"Note":{"properties":{"associated_with":{"$ref":"#/components/schemas/EmbeddedResource"},"call":{"$ref":"#/components/schemas/EmbeddedResource"},"content":{"description":"The content of the note","example":"Was very interested in a demo at a later time","type":"string"},"created_at":{"description":"Datetime of when the note was created","example":"2018-02-01T15:02:39.465679-05:00","format":"date","type":"string"},"id":{"description":"Note ID","example":1,"type":"integer"},"updated_at":{"description":"Datetime of when the note was last updated","example":"2018-02-01T15:02:39.465758-05:00","format":"date","type":"string"},"user":{"$ref":"#/components/schemas/EmbeddedResource"}}},"Person":{"properties":{"account":{"$ref":"#/components/schemas/EmbeddedResource"},"bouncing":{"description":"Whether this person's current email address has bounced","example":false,"type":"boolean"},"city":{"description":"City","example":"Atlanta","type":"string"},"country":{"description":"Country","example":"United States","type":"string"},"counts":{"$ref":"#/components/schemas/PersonCounts"},"created_at":{"description":"Datetime of when the person was created","example":"2018-02-01T15:02:39.476041-05:00","format":"date","type":"string"},"crm_id":{"description":"CRM ID, currently Salesforce.com only","example":"003i000001mnhpD","type":"string"},"crm_object_type":{"description":"CRM object type, currently Salesforce.com only","example":"Lead","type":"string"},"crm_url":{"description":"CRM url, currently Salesforce.com only","example":"https://na15.salesforce.com/003i000001mnhpD","type":"string"},"custom_fields":{"description":"Custom fields are defined by the user's team. Only fields with values are presented in the API.","example":{"MyField":"A Value","Other":"Field"},"type":"object"},"display_name":{"description":"Either the full name or the email address. Use this when showing a person's name","example":"Pat Johnson","type":"string"},"do_not_contact":{"description":"Whether or not this person has opted out of communications. Do not contact someone when this is set to true","example":true,"type":"boolean"},"email_address":{"description":"Email address","example":"pat.johnson@example.com","type":"string"},"first_name":{"description":"First name","example":"Pat","type":"string"},"home_phone":{"description":"Home phone without formatting","example":"+1 444 555 6666","type":"string"},"id":{"description":"Person ID","example":1,"type":"integer"},"import":{"$ref":"#/components/schemas/EmbeddedResource"},"last_contacted_at":{"description":"Last datetime this person was contacted","example":"2018-02-01T15:02:39.476168-05:00","format":"date","type":"string"},"last_contacted_by":{"$ref":"#/components/schemas/EmbeddedResource"},"last_contacted_type":{"description":"The type of the last touch to this person. Can be call, email, other","example":"call","type":"string"},"last_name":{"description":"Last name","example":"Johnson","type":"string"},"last_replied_at":{"description":"Last datetime this person replied to an email","example":"2018-02-01T15:02:39.476192-05:00","format":"date","type":"string"},"linkedin_url":{"description":"Linkedin URL","example":"https://www.linkedin.com/in/username","type":"string"},"locale":{"description":"Time locale of the person","example":"US/Eastern","type":"string"},"mobile_phone":{"description":"Mobile phone without formatting","example":"+1 444 555 6666","type":"string"},"owner":{"$ref":"#/components/schemas/EmbeddedResource"},"owner_crm_id":{"description":"Mapped owner field from the CRM, currently Salesforce.com only","example":"003i000001mnhpD","type":"string"},"person_company_industry":{"description":"Company industry. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended","example":"Information Technology","type":"string"},"person_company_name":{"description":"Company name. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended","example":"SalesLoft","type":"string"},"person_company_website":{"description":"Company website. This property is specific to this person, unrelated to the company object. Updating the company object associated with this person is recommended","example":"https://salesloft.com","type":"string"},"person_stage":{"$ref":"#/components/schemas/EmbeddedResource"},"personal_email_address":{"description":"Personal email address","example":"pat.johnson@example.com","type":"string"},"personal_website":{"description":"The website of this person","example":"https://salesloft.com","type":"string"},"phone":{"description":"Phone without formatting","example":"+1 444 555 6666","type":"string"},"phone_extension":{"description":"Phone extension without formatting","example":"x123","type":"string"},"secondary_email_address":{"description":"Alternate email address","example":"pat.johnson@example.com","type":"string"},"state":{"description":"State","example":"Georgia","type":"string"},"tags":{"description":"All tags applied to this person","example":["7-23-2017","dreamforce"],"items":{"type":"string"},"type":"array"},"title":{"description":"Job title","example":"Sales Development Representative","type":"string"},"twitter_handle":{"description":"The twitter handle of this person","example":"@kyleporter","type":"string"},"updated_at":{"description":"Datetime of when the person was last updated","example":"2018-02-01T15:02:39.476136-05:00","format":"date","type":"string"},"work_city":{"description":"Work location - city","example":"Atlanta","type":"string"},"work_country":{"description":"Work location - country","example":"United States","type":"string"},"work_state":{"description":"Work location - state","example":"Georgia","type":"string"}}},"PersonCounts":{"properties":{"calls":{"description":"The number of calls logged to this person","example":4,"type":"integer"},"emails_bounced":{"description":"The number of unique emails sent to this person that bounced","example":0,"type":"integer"},"emails_clicked":{"description":"The number of unique emails clicked by this person","example":1,"type":"integer"},"emails_replied_to":{"description":"The number of unique emails replied to by this person","example":0,"type":"integer"},"emails_sent":{"description":"The number of emails sent to this person","example":3,"type":"integer"},"emails_viewed":{"description":"The number of unique emails viewed by this person","example":2,"type":"integer"}}},"PersonStage":{"properties":{"created_at":{"description":"Datetime of when the Person Stage was created","example":"2018-02-01T15:02:39.490199-05:00","format":"date","type":"string"},"id":{"description":"ID of Person Stage","example":1,"type":"integer"},"name":{"description":"Name of Person Stage","example":"Entry Stage","type":"string"},"updated_at":{"description":"Datetime of when the Person Stage was last updated","example":"2018-02-01T15:02:39.490254-05:00","format":"date","type":"string"}}},"RecordingSetting":{"properties":{"recording_default":{"description":"Whether this phone number should record by default","example":true,"type":"boolean"}}},"Step":{"properties":{"cadence":{"$ref":"#/components/schemas/EmbeddedResource"},"created_at":{"description":"Datetime of when the Step was created","example":"2018-02-01T15:02:39.565505-05:00","format":"date","type":"string"},"day":{"description":"Day this step is associated with up","example":1,"type":"integer"},"details":{"$ref":"#/components/schemas/EmbeddedResource"},"disabled":{"description":"Whether this step is currently active","example":true,"type":"boolean"},"display_name":{"description":"Display name of the step","example":"Day 1: Step 2 - Phone","type":"string"},"id":{"description":"ID of Step","example":1,"type":"integer"},"step_number":{"description":"The number of the step for this day","example":1,"type":"integer"},"type":{"description":"The type of the action scheduled by this step. Valid types are: email, phone, other. New types may be added in the future.\n","example":"phone","type":"string"},"updated_at":{"description":"Datetime of when the Step was last updated","example":"2018-02-01T15:02:39.565572-05:00","format":"date","type":"string"}}},"Success":{"properties":{"counts":{"$ref":"#/components/schemas/SuccessCounts"},"created_at":{"description":"Datetime of when the success was created","example":"2018-02-01T15:02:39.500168-05:00","format":"date","type":"string"},"id":{"description":"ID of success","example":1,"type":"integer"},"latest_action":{"$ref":"#/components/schemas/EmbeddedResource"},"latest_call":{"$ref":"#/components/schemas/EmbeddedResource"},"latest_email":{"$ref":"#/components/schemas/EmbeddedResource"},"person":{"$ref":"#/components/schemas/EmbeddedResource"},"succeeded_at":{"description":"Datetime of when the success was recorded","example":"2018-02-01T15:02:39.500274-05:00","format":"date","type":"string"},"success_window_started_at":{"description":"Datetime of when this person was first worked, leading up to the success","example":"2018-02-01T15:02:39.500302-05:00","format":"date","type":"string"},"updated_at":{"description":"Datetime of when the success was last updated","example":"2018-02-01T15:02:39.500224-05:00","format":"date","type":"string"},"user":{"$ref":"#/components/schemas/EmbeddedResource"}}},"SuccessCounts":{"properties":{"total_calls":{"description":"The total number of calls made in this success window","example":5,"type":"integer"},"total_emails":{"description":"The total number of emails made in this success window","example":2,"type":"integer"},"total_other_touches":{"description":"The total number of other touches made in this success window","example":3,"type":"integer"}}},"Team":{"properties":{"allow_automated_email_steps":{"description":"Whether team members are allowed to have automated email steps","example":true,"type":"boolean"},"call_recording_disabled":{"description":"Whether all call recording is disabled","example":false,"type":"boolean"},"click_tracking_default":{"description":"The team default for click tracking when composing emails","example":true,"type":"boolean"},"created_at":{"description":"Datetime of when the team was created","example":"2018-02-01T15:02:39.506235-05:00","format":"date","type":"string"},"custom_tracking_domain":{"description":"The domain click and open tracking will be proxied through","example":"examplecompany.com","type":"string"},"dispositions_required":{"description":"Whether team members are required to mark disposition at the end of calls","example":false,"type":"boolean"},"email_daily_limit":{"description":"Daily email limit for each member on the team","example":1000,"type":"integer"},"group_privacy_setting":{"description":"Visibility setting for resources across the team. Possible values are: group_public, all_public.\nWhen the value is group_public, certain resources will only be visible to members of the same group.\nWhen the value is all_public, all resources are visible to all users on this team.\n","example":"all_public","type":"string"},"id":{"description":"Team ID","example":1,"type":"integer"},"license_limit":{"description":"Count of seats that this team has licensed","example":100,"type":"integer"},"local_dial_enabled":{"description":"Whether this team has local dial enabled","example":true,"type":"boolean"},"name":{"description":"Team name","example":"The A-Team","type":"string"},"plan":{"description":"Plan type of the team, Possible values are: group, professional, enterprise","example":"professional","type":"string"},"record_by_default":{"description":"Whether calls will record by default","example":true,"type":"boolean"},"sentiments_required":{"description":"Whether team members are required to log sentiments","example":false,"type":"boolean"},"team_visibility_default":{"description":"The default visibility of resources on the team, in the UI only. The API does not utilize this default.\nPossible values are: public, private.\n","example":"public","type":"string"},"updated_at":{"description":"Datetime of when the team was last updated","example":"2018-02-01T15:02:39.506288-05:00","format":"date","type":"string"}}},"TeamTemplate":{"properties":{"archived_at":{"description":"Datetime of when the team template was archived, if archived","example":"2018-02-01T15:02:39.511488-05:00","format":"date","type":"string"},"body":{"description":"Body of the team template","example":"<div>Do you know about birds?</div><div>You can find them here: <a href=\"https://www.allaboutbirds.org/guide/search/\" target=\"_blank\">https://www.allaboutbirds.org/guide/search/</a></div>","type":"string"},"click_tracking_enabled":{"description":"Whether click tracking is enabled for this team template","example":true,"type":"boolean"},"counts":{"$ref":"#/components/schemas/TeamTemplateCounts"},"created_at":{"description":"Datetime of when the team template was created","example":"2018-02-01T15:02:39.511362-05:00","format":"date","type":"string"},"id":{"description":"ID of team template","example":"51226150-3108-4dea-883b-0c0d7388f456","type":"string"},"last_modified_at":{"description":"Datetime of when the team template was last modified","example":"2018-02-01T15:02:39.511548-05:00","format":"date","type":"string"},"last_modified_user":{"$ref":"#/components/schemas/EmbeddedResource"},"last_used_at":{"description":"Datetime of when the team template was last used","example":"2018-02-01T15:02:39.511464-05:00","format":"date","type":"string"},"open_tracking_enabled":{"description":"Whether open tracking is enabled for this team template","example":true,"type":"boolean"},"subject":{"description":"Subject of the team template","example":"It’s time to say goodbye","type":"string"},"title":{"description":"Title of the team template","example":"VP Breakup Email","type":"string"},"updated_at":{"description":"Datetime of when the team template was last updated","example":"2018-02-01T15:02:39.511438-05:00","format":"date","type":"string"}}},"TeamTemplateCounts":{"properties":{"bounces":{"description":"The number of bounces the team template received","example":10,"type":"integer"},"clicks":{"description":"The number of times links in the team template were clicked","example":20,"type":"integer"},"replies":{"description":"The number of replies the team template received","example":1,"type":"integer"},"sent_emails":{"description":"The number of times the team template was sent out","example":59,"type":"integer"},"views":{"description":"The number of times the team template was opened","example":3,"type":"integer"}}},"User":{"properties":{"active":{"description":"Whether an user is currently active in SalesLoft","example":true,"type":"boolean"},"bcc_email_address":{"description":"Address that will be BBC'd on all emails from this user","example":"fake@salesloft.com","type":"string"},"click_to_call_enabled":{"description":"Whether this user has click to call enabled","example":true,"type":"boolean"},"created_at":{"description":"Datetime of when the user was created","example":"2018-02-01T15:02:39.460736-05:00","format":"date","type":"string"},"crm_connected":{"description":"Whether the user has a crm connected","example":true,"type":"boolean"},"email":{"description":"Email address provided to accounts.salesloft.com","example":"fake@salesloft.com","type":"string"},"email_client_configured":{"description":"Whether this user has a email client configured","example":true,"type":"boolean"},"email_client_email_address":{"description":"Email address associated with the email client of the user","example":"fake@salesloft.com","type":"string"},"email_signature":{"description":"Email signature","example":"Benjamin Franklin<div></div><div></div>","type":"string"},"email_signature_click_tracking_disabled":{"description":"Whether this user has click tracking disabled in email signature","example":false,"type":"boolean"},"email_signature_type":{"description":"Email signature type","example":"html","type":"string"},"first_name":{"description":"First name of user","example":"Benjamin","type":"string"},"from_address":{"description":"The from address of this user","example":"fake@salesloft.com","type":"string"},"full_email_address":{"description":"RFC 5322 compliant email address","example":"\"Benjamin Franklin\" <Benjamin@salesloft.com>","type":"string"},"group":{"$ref":"#/components/schemas/EmbeddedResource"},"id":{"description":"User ID","example":1,"type":"integer"},"last_name":{"description":"Last name of user","example":"Franklin","type":"string"},"local_dial_enabled":{"description":"Whether this user has Local Dial enabled","example":true,"type":"boolean"},"name":{"description":"Display name of user","example":"Benjamin Franklin","type":"string"},"phone_client":{"$ref":"#/components/schemas/EmbeddedResource"},"phone_number_assignment":{"$ref":"#/components/schemas/EmbeddedResource"},"sending_email_address":{"description":"The email address that email of the user will be sent from, resolved in the following resolution order: from_user, email_client_email_address, email","example":"fake@salesloft.com","type":"string"},"slack_username":{"description":"Slack username","example":"benjamin-franklin","type":"string"},"team":{"$ref":"#/components/schemas/EmbeddedResource"},"team_admin":{"description":"Team Admin","example":true,"type":"boolean"},"time_zone":{"description":"User Time Zone","example":"US/Eastern","type":"string"},"twitter_handle":{"description":"Twitter handle","example":"@benjamin-franklin","type":"string"},"updated_at":{"description":"Datetime of when the user was last updated","example":"2018-02-01T15:02:39.460810-05:00","format":"date","type":"string"}}}}}} |