openapi: 3.1.0 info: title: CRM API Reference version: "2.0" summary: API servers: - url: "https://api.vessel.dev" paths: /crm/users: get: summary: Get All Users tags: - users responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: users: type: array items: $ref: "#/components/schemas/User" nextPageCursor: type: string examples: example-1: value: users: - id: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 nativeId: "12" firstName: Micheal lastName: Scott email: micheal@dundermifflin.com createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" additional: {} nextPageCursor: string operationId: get-all-crm-users parameters: - schema: type: string in: query name: accessToken required: true description: The token for the customer's CRM account. This was generated when they connected their account. - schema: type: string in: query name: cursor - schema: type: number in: query name: limit description: The number of records to return per page. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response - schema: type: boolean in: query name: archived description: Set to true to include archived users in the response. Defaults to false. description: Retrieve all Users parameters: [] /crm/users/associations: post: summary: Associations for Users requestBody: content: application/json: schema: type: object properties: objectType: type: string enum: [account, contact, deal, note, email, event, task, call] ids: type: array items: type: string accessToken: type: string cursor: type: string operationId: get-all-crm-users-associations description: Associations for given User Ids /crm/users/search: post: summary: Search Users tags: - users requestBody: content: application/json: schema: type: object properties: filters: type: object properties: id: $ref: "#/components/schemas/StringFilter" nativeId: $ref: "#/components/schemas/StringFilter" firstName: $ref: "#/components/schemas/StringFilter" lastName: $ref: "#/components/schemas/StringFilter" email: $ref: "#/components/schemas/StringFilter" createdTime: $ref: "#/components/schemas/DateFilter" modifiedTime: $ref: "#/components/schemas/DateFilter" responses: "200": description: OK content: application/json: schema: type: object properties: users: type: array items: $ref: "#/components/schemas/User" nextPageCursor: type: string title: responseBody examples: example-1: value: users: - id: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 nativeId: "12" firstName: Micheal lastName: Scott email: micheal@dundermifflin.com createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" additional: {} nextPageCursor: string operationId: search-crm-users description: Search all Users using filters parameters: - $ref: '#/components/parameters/accessToken' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/allFields' /crm/user: get: summary: Get User tags: - users responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: user: $ref: "#/components/schemas/User" examples: example-1: value: user: id: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 nativeId: "12" firstName: Micheal lastName: Scott email: micheal@dundermifflin.com createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" additional: {} operationId: get-one-crm-user parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: id required: true - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve a single User by Id parameters: [] /crm/user/details: get: summary: Get User Details tags: - users responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: fields: type: array items: $ref: "#/components/schemas/Field" nextPageCursor: type: string examples: example-1: value: fields: - key: firstName name: First name type: string options: null isArray: false custom: false universal: true required: false creatable: true updatable: true nextPageCursor: string operationId: get-details-crm-user description: |- Get details about all users. Details include the type, possible values, and other meta data about the fields. parameters: - schema: type: string in: query name: accessToken description: "The token for the customer's CRM account. This was generated when they connected their account." required: true - schema: type: string in: query name: cursor - schema: type: boolean in: query name: allFields description: "Returns details about native fields." /crm/user/batch: get: summary: Get Batch Users tags: - users responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: users: type: array items: $ref: "#/components/schemas/User" invalidIds: $ref: "#/components/schemas/InvalidIds" examples: example-1: value: users: - id: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 nativeId: "12" firstName: Micheal lastName: Scott email: micheal@dundermifflin.com createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" additional: {} operationId: get-batch-crm-user parameters: - schema: type: string in: query name: accessToken required: true description: The token for the customer's CRM account. This was generated when they connected their account. - schema: type: string in: query name: ids description: Comma separated list of User Id's. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve Users by a set of Id's parameters: [] /crm/contacts: get: summary: Get All Contacts tags: - contacts responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: contacts: type: array items: $ref: "#/components/schemas/Contact" nextPageCursor: type: string examples: example-1: value: contacts: - id: v.contact.e5f32d4fd2115220bd20a2ccf81210ec nativeId: "23" email: tom@bluecross.com firstName: Tom lastName: Smith jobTitle: Director of Operations phone: "2101128833" mobilePhone: "2106541111" createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: get-all-crm-contacts parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: cursor - schema: type: number in: query name: limit description: The number of records to return per page. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve all Contacts parameters: [] /crm/contacts/search: post: summary: Search Contacts tags: - contacts requestBody: content: application/json: schema: type: object properties: filters: type: object properties: id: $ref: "#/components/schemas/StringFilter" nativeId: $ref: "#/components/schemas/StringFilter" firstName: $ref: "#/components/schemas/StringFilter" lastName: $ref: "#/components/schemas/StringFilter" jobTitle: $ref: "#/components/schemas/StringFilter" email: $ref: "#/components/schemas/StringFilter" phone: $ref: "#/components/schemas/StringFilter" mobilePhone: $ref: "#/components/schemas/StringFilter" createdTime: $ref: "#/components/schemas/DateFilter" modifiedTime: $ref: "#/components/schemas/DateFilter" responses: "200": description: OK content: application/json: schema: type: object properties: contacts: type: array items: $ref: "#/components/schemas/Contact" nextPageCursor: type: string title: responseBody examples: example-1: value: contacts: - id: v.contact.e5f32d4fd2115220bd20a2ccf81210ec nativeId: "23" email: tom@bluecross.com firstName: Tom lastName: Smith jobTitle: Director of Operations phone: "2101128833" mobilePhone: "2106541111" createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: search-crm-contacts description: Search all Contacts using filters parameters: - $ref: '#/components/parameters/accessToken' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/allFields' /crm/contact: get: summary: Get Contact tags: - contacts responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: contact: $ref: "#/components/schemas/Contact" examples: example-1: value: contact: id: v.contact.e5f32d4fd2115220bd20a2ccf81210ec nativeId: "23" email: tom@bluecross.com firstName: Tom lastName: Smith jobTitle: Director of Operations phone: "2101128833" mobilePhone: "2106541111" createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-one-crm-contact parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: id description: The id of the contact to get - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: "Retrieve a Contact by either Id or email. When both email and Id are included, Id will take priority." parameters: [] post: summary: Create Contact tags: - contacts operationId: post-crm-contact responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: id: type: string examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string contact: $ref: "#/components/schemas/ContactCreate" required: - accessToken - contact examples: example-1: value: accessToken: string contact: email: tom@bluecross.com firstName: Tom lastName: Smith jobTitle: Director of Operations phone: "2101128833" mobilePhone: "2106541111" description: Create a new contact. patch: summary: Update Contact tags: - contacts operationId: put-crm-contact responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string id: type: string contact: $ref: "#/components/schemas/ContactUpdate" required: - accessToken - id - contact examples: example-1: value: accessToken: string id: string contact: email: tom@bluecross.com firstName: Tom lastName: Smith jobTitle: Director of Operations phone: "2101128833" mobilePhone: "2106541111" application/xml: schema: type: object properties: {} description: "" description: Update an existing Contact. /crm/contact/details: get: summary: Get Contact Details tags: - contacts responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: fields: type: array items: $ref: "#/components/schemas/Field" nextPageCursor: type: string examples: example-1: value: fields: - key: firstName name: First name type: string options: null isArray: false custom: false universal: true required: false creatable: true updatable: true nextPageCursor: string operationId: get-details-crm-contact description: |- Get details about all contacts. Details include the type, possible values, and other meta data about the fields. parameters: - schema: type: string in: query name: accessToken description: "The token for the customer's CRM account. This was generated when they connected their account." required: true - schema: type: string in: query name: cursor - schema: type: boolean in: query name: allFields description: "Returns details about native fields." /crm/contact/custom-field: post: summary: Create Contact Custom Field description: "Supported for Salesforce and HubSpot" tags: - contactCustomFields operationId: post-contact-custom-field responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: success: true properties: key: type: string description: "The key used to access the custom field" examples: example-1: value: success: true requestBody: content: application/json: schema: type: object properties: accessToken: $ref: '#/components/parameters/accessToken' customField: $ref: "#/components/schemas/CustomFieldCreate" required: - accessToken - customField patch: summary: Update Contact Custom Field description: "Supported for Salesforce and HubSpot" operationId: patch-contact-custom-field responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: success: true properties: key: type: string description: "The key used to access the custom field" examples: example-1: value: success: true requestBody: content: application/json: schema: type: object properties: accessToken: $ref: '#/components/parameters/accessToken' customField: $ref: "#/components/schemas/CustomFieldUpdate" required: - accessToken - customField /crm/contact/batch: get: summary: Get Batch Contacts tags: - contacts responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: contacts: type: array items: $ref: "#/components/schemas/Contact" invalidIds: $ref: "#/components/schemas/InvalidIds" examples: example-1: value: contacts: - id: v.contact.e5f32d4fd2115220bd20a2ccf81210ec nativeId: "23" email: tom@bluecross.com firstName: Tom lastName: Smith jobTitle: Director of Operations phone: "2101128833" mobilePhone: "2106541111" createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa additional: {} operationId: get-batch-crm-contact parameters: - schema: type: string in: query name: accessToken required: true description: The token for the customer's CRM account. This was generated when they connected their account. - schema: type: string in: query name: ids description: Comma separated list of Contact Id's. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve Contacts by a set of Id's parameters: [] /crm/deals: get: summary: Get All Deals tags: - deals responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: deals: type: array items: $ref: "#/components/schemas/Deal" nextPageCursor: type: string examples: example-1: value: deals: - id: v.deal.497fb529e6805351b5dc8057c74a4a52 nativeId: "84" name: Blue Cross Deal stage: demo amount: 10000 closeDate: "2020-08-23T00:00:00Z" probability: "0.4" expectedRevenue: 4000 isWon: false isClosed: false modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: get-all-crm-deals parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: cursor - schema: type: number in: query name: limit description: The number of records to return per page. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve all Deals parameters: [] /crm/deals/search: post: summary: Search Deals tags: - deals requestBody: content: application/json: schema: type: object properties: filters: type: object properties: id: $ref: "#/components/schemas/StringFilter" nativeId: $ref: "#/components/schemas/StringFilter" closeDate: $ref: "#/components/schemas/DateFilter" name: $ref: "#/components/schemas/StringFilter" amount: $ref: "#/components/schemas/NumberFilter" probability: $ref: "#/components/schemas/NumberFilter" stage: $ref: "#/components/schemas/StringFilter" isWon: $ref: "#/components/schemas/BooleanFilter" isClosed: $ref: "#/components/schemas/BooleanFilter" expectedRevenue: $ref: "#/components/schemas/NumberFilter" createdTime: $ref: "#/components/schemas/DateFilter" modifiedTime: $ref: "#/components/schemas/DateFilter" responses: "200": description: OK content: application/json: schema: type: object properties: deals: type: array items: $ref: "#/components/schemas/Deal" nextPageCursor: type: string title: responseBody examples: example-1: value: deals: - id: v.deal.497fb529e6805351b5dc8057c74a4a52 nativeId: "84" name: Blue Cross Deal stage: demo amount: 10000 closeDate: "2020-08-23T00:00:00Z" probability: "0.4" expectedRevenue: 4000 isWon: false isClosed: false modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: search-crm-deals description: Search all Deals using filters parameters: - $ref: '#/components/parameters/accessToken' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/allFields' /crm/deal: get: summary: Get Deal tags: - deals responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: deal: $ref: "#/components/schemas/Deal" examples: example-1: value: deal: id: v.deal.497fb529e6805351b5dc8057c74a4a52 nativeId: "84" name: Blue Cross Deal stage: demo amount: 10000 closeDate: "2020-08-23T00:00:00Z" probability: "0.4" expectedRevenue: 4000 isWon: false isClosed: false modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-one-crm-deal parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: id required: true - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve a single Deal by Id parameters: [] post: summary: Create Deal tags: - deals operationId: post-crm-deal responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string deal: $ref: "#/components/schemas/DealCreate" required: - accessToken - deal examples: example-1: value: accessToken: string deal: name: Blue Cross Deal amount: 10000 closeDate: "2020-08-23T00:00:00Z" probability: "0.4" stage: closedwon accountId: v.account.0dcb45e051315a6ea63b0f16e73689d9 contactId: v.contact.1dcb443051315a6e463b0f16e73689d9 description: Create a new Deal patch: summary: Update Deal tags: - deals operationId: put-crm-deal responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string id: type: string deal: $ref: "#/components/schemas/DealUpdate" required: - accessToken - id - deal examples: example-1: value: accessToken: string id: string deal: name: Blue Cross Deal amount: 10000 closeDate: "2020-08-23T00:00:00Z" probability: "0.4" accountId: v.account.0dcb45e051315a6ea63b0f16e73689d9 description: "" description: Update an existing Deal /crm/deal/details: get: summary: Get Deal Details tags: - deals responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: fields: type: array items: $ref: "#/components/schemas/Field" nextPageCursor: type: string examples: example-1: value: fields: - key: amount name: Amount type: number options: null isArray: false custom: false universal: true required: false creatable: true updatable: true nextPageCursor: string operationId: get-details-crm-deal description: |- Get details about all deals or a particular deal. Details include the type, possible values, and other meta data about the fields. parameters: - schema: type: string in: query name: accessToken description: "The token for the customer's CRM account. This was generated when they connected their account." required: true - schema: type: string in: query name: id description: "If provided, get the details about a particular deal. If not provided, get details about all deals." - schema: type: string in: query name: cursor - schema: type: boolean in: query name: allFields description: "Returns details about native fields." /crm/deal/batch: get: summary: Get Batch Deals tags: - deals responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: deals: type: array items: $ref: "#/components/schemas/Deal" invalidIds: $ref: "#/components/schemas/InvalidIds" examples: example-1: value: deals: - id: v.deal.497fb529e6805351b5dc8057c74a4a52 nativeId: "84" name: Blue Cross Deal stage: demo amount: 10000 closeDate: "2020-08-23T00:00:00Z" probability: "0.4" expectedRevenue: 4000 isWon: false isClosed: false modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-batch-crm-deal parameters: - schema: type: string in: query name: accessToken required: true description: The token for the customer's CRM account. This was generated when they connected their account. - schema: type: string in: query name: ids description: Comma separated list of Deal Id's. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve Deals by a set of Id's parameters: [] /crm/accounts: get: summary: Get All Accounts tags: - accounts responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: accounts: type: array items: $ref: "#/components/schemas/Account" nextPageCursor: type: string examples: example-1: value: accounts: - id: v.account.0dcb45e051315a6ea63b0f16e73689d9 nativeId: "344" name: Blue Cross description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton industry: TV and Media annualRevenue: 10000000 numberOfEmployees: 100 website: www.bluecross.penn createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" phone: "8192223333" address: street: 100 Blue Dr city: Scranton state: Pennsylvania postalCode: "281332" country: USA associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: get-all-crm-accounts parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: cursor - schema: type: number in: query name: limit description: The number of records to return per page. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: |- Retrieve all Accounts parameters: [] /crm/accounts/search: post: summary: Search Accounts tags: - accounts requestBody: content: application/json: schema: type: object properties: filters: type: object properties: id: $ref: "#/components/schemas/StringFilter" nativeId: $ref: "#/components/schemas/StringFilter" name: $ref: "#/components/schemas/StringFilter" description: $ref: "#/components/schemas/StringFilter" industry: $ref: "#/components/schemas/StringFilter" website: $ref: "#/components/schemas/StringFilter" street: $ref: "#/components/schemas/StringFilter" city: $ref: "#/components/schemas/StringFilter" state: $ref: "#/components/schemas/StringFilter" postalCode: $ref: "#/components/schemas/StringFilter" country: $ref: "#/components/schemas/StringFilter" phone: $ref: "#/components/schemas/StringFilter" annualRevenue: $ref: "#/components/schemas/NumberFilter" numberOfEmployees: $ref: "#/components/schemas/NumberFilter" createdTime: $ref: "#/components/schemas/DateFilter" modifiedTime: $ref: "#/components/schemas/DateFilter" responses: "200": description: OK content: application/json: schema: type: object properties: accounts: type: array items: $ref: "#/components/schemas/Account" nextPageCursor: type: string title: responseBody examples: example-1: value: accounts: - id: v.account.0dcb45e051315a6ea63b0f16e73689d9 nativeId: "344" name: Blue Cross description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton industry: TV and Media annualRevenue: 10000000 numberOfEmployees: 100 website: www.bluecross.penn createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" phone: "8192223333" address: street: 100 Blue Dr city: Scranton state: Pennsylvania postalCode: "281332" country: USA associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: search-crm-accounts description: Search all Accounts using filters parameters: - $ref: '#/components/parameters/accessToken' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/allFields' /crm/account: get: summary: Get Account tags: - accounts responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: account: $ref: "#/components/schemas/Account" examples: example-1: value: account: id: v.account.0dcb45e051315a6ea63b0f16e73689d9 nativeId: "344" name: Blue Cross description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton industry: TV and Media annualRevenue: 10000000 numberOfEmployees: 100 website: www.bluecross.penn createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" phone: "8192223333" address: street: 100 Blue Dr city: Scranton state: Pennsylvania postalCode: "281332" country: USA associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-one-crm-account parameters: - schema: type: string in: query required: true name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. - schema: type: string in: query name: id required: true - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve a single Account by Id parameters: [] post: summary: Create Account tags: - accounts operationId: post-crm-account responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string examples: example-1: value: id: string requestBody: content: application/json: schema: type: object properties: accessToken: type: string account: $ref: "#/components/schemas/AccountCreate" required: - accessToken - account examples: example-1: value: accessToken: string account: name: Blue Cross description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton industry: TV and Media annualRevenue: 10000000 numberOfEmployees: 100 website: www.bluecross.penn phone: "8192223333" address: street: 100 Blue Dr city: Scranton state: Pennsylvania postalCode: "281332" country: USA description: Create a new Account patch: summary: Update Account tags: - accounts operationId: put-crm-account responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string id: type: string account: $ref: "#/components/schemas/AccountUpdate" required: - accessToken - id - account examples: example-1: value: accessToken: string id: string account: name: Blue Cross description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton industry: TV and Media annualRevenue: 10000000 numberOfEmployees: 100 website: www.bluecross.penn createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" phone: "8192223333" address: street: 100 Blue Dr city: Scranton state: Pennsylvania postalCode: "281332" country: USA description: Update an existing Account parameters: [] /crm/account/details: get: summary: Get Account Details tags: - accounts responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: fields: type: array items: $ref: "#/components/schemas/Field" nextPageCursor: type: string examples: example-1: value: fields: - key: name name: Name type: string options: null isArray: false custom: false universal: true required: false creatable: true updatable: true nextPageCursor: string operationId: get-details-crm-account description: |- Get details about all accounts. Details include the type, possible values, and other meta data about the fields. parameters: - schema: type: string in: query name: accessToken description: "The token for the customer's CRM account. This was generated when they connected their account." required: true - schema: type: string in: query name: cursor - schema: type: boolean in: query name: allFields description: "Returns details about native fields." /crm/account/batch: get: summary: Get Batch Accounts tags: - accounts responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: accounts: type: array items: $ref: "#/components/schemas/Account" invalidIds: $ref: "#/components/schemas/InvalidIds" examples: example-1: value: accounts: - id: v.account.0dcb45e051315a6ea63b0f16e73689d9 nativeId: "344" name: Blue Cross description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton industry: TV and Media annualRevenue: 10000000 numberOfEmployees: 100 website: www.bluecross.penn createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" phone: "8192223333" address: street: 100 Blue Dr city: Scranton state: Pennsylvania postalCode: "281332" country: USA associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-batch-crm-account parameters: - schema: type: string in: query name: accessToken required: true description: The token for the customer's CRM account. This was generated when they connected their account. - schema: type: string in: query name: ids description: Comma separated list of Account Id's. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve Accounts by a set of Id's parameters: [] /crm/account/custom-field: patch: summary: Update Account Custom Field description: "Supported for Salesforce and HubSpot" operationId: patch-account-custom-field responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: success: true properties: key: type: string description: "The key used to access the custom field" examples: example-1: value: success: true requestBody: content: application/json: schema: type: object properties: accessToken: $ref: '#/components/parameters/accessToken' customField: $ref: "#/components/schemas/CustomFieldUpdate" required: - accessToken - customField /crm/leads: get: summary: Get All Leads tags: - leads responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: leads: type: array items: $ref: "#/components/schemas/Lead" nextPageCursor: type: string examples: example-1: value: leads: - id: v.lead.d08f345ace24509e911a0ea8e3d2203c nativeId: "23" firstName: Tom lastName: Smith jobTitle: Director of Operations email: tom@bluecross.com account: Blue Cross phone: "1234445555" mobilePhone: "2338889999" createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa additional: {} nextPageCursor: string operationId: get-all-crm-leads description: |- Retrieve all leads. *CRM Caveats*: - Pipedrive: Only `jobTitle` is returned when querying for all leads parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: cursor - schema: type: number in: query name: limit description: The number of records to return per page. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response /crm/leads/search: post: summary: Search Leads tags: - leads requestBody: content: application/json: schema: type: object properties: filters: type: object properties: id: $ref: "#/components/schemas/StringFilter" nativeId: $ref: "#/components/schemas/StringFilter" lastName: $ref: "#/components/schemas/StringFilter" firstName: $ref: "#/components/schemas/StringFilter" jobTitle: $ref: "#/components/schemas/StringFilter" email: $ref: "#/components/schemas/StringFilter" account: $ref: "#/components/schemas/StringFilter" phone: $ref: "#/components/schemas/StringFilter" mobilePhone: $ref: "#/components/schemas/StringFilter" createdTime: $ref: "#/components/schemas/DateFilter" modifiedTime: $ref: "#/components/schemas/DateFilter" responses: "200": description: OK content: application/json: schema: type: object properties: leads: type: array items: $ref: "#/components/schemas/Lead" nextPageCursor: type: string title: responseBody examples: example-1: value: leads: - id: v.lead.d08f345ace24509e911a0ea8e3d2203c nativeId: "23" firstName: Tom lastName: Smith jobTitle: Director of Operations email: tom@bluecross.com account: Blue Cross phone: "1234445555" mobilePhone: "2338889999" createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa additional: {} nextPageCursor: string operationId: search-crm-leads description: Search all Leads using filters parameters: - $ref: '#/components/parameters/accessToken' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/allFields' /crm/lead: get: summary: Get Lead tags: - leads responses: "200": description: OK headers: {} content: application/json: schema: title: responseBody type: object properties: lead: $ref: "#/components/schemas/Lead" examples: example-1: value: lead: id: v.lead.d08f345ace24509e911a0ea8e3d2203c nativeId: "23" firstName: Tom lastName: Smith jobTitle: Director of Operations email: tom@bluecross.com account: Blue Cross phone: "1234445555" mobilePhone: "2338889999" createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa additional: {} operationId: get-one-crm-lead description: Retrieve a single Lead by Id parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: id required: true - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response post: summary: Create Lead tags: - leads operationId: post-crm-lead responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: string description: Create a new Lead requestBody: content: application/json: schema: type: object properties: accessToken: type: string lead: $ref: "#/components/schemas/LeadCreate" required: - accessToken - lead examples: example-1: value: accessToken: string lead: firstName: Tom lastName: Smith jobTitle: Director of Operations email: tom@bluecross.com account: Blue Cross phone: "1234445555" mobilePhone: "2338889999" patch: summary: Update Lead tags: - leads operationId: put-crm-lead responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" description: Update an existing Lead by Id requestBody: content: application/json: schema: type: object properties: accessToken: type: string id: type: string lead: $ref: "#/components/schemas/LeadUpdate" required: - accessToken - id - lead examples: example-1: value: accessToken: string lead: firstName: Tom lastName: Smith jobTitle: Director of Operations email: tom@bluecross.com account: Blue Cross phone: "1234445555" mobilePhone: "2338889999" /crm/lead/details: get: summary: Get Lead Details tags: - leads responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: fields: type: array items: $ref: "#/components/schemas/Field" nextPageCursor: type: string examples: example-1: value: fields: - key: firstName name: First Name type: string options: null isArray: false custom: false universal: true required: false creatable: true updatable: true nextPageCursor: string operationId: get-details-crm-lead description: |- Get details about all leads. Details include the type, possible values, and other meta data about the fields. parameters: - schema: type: string in: query name: accessToken description: "The token for the customer's CRM account. This was generated when they connected their account." required: true - schema: type: string in: query name: cursor - schema: type: boolean in: query name: allFields description: "Returns details about native fields." /crm/lead/custom-field: post: summary: Create Lead Custom Field description: "Supported for Salesforce and HubSpot" tags: - leadCustomFields operationId: post-lead-custom-field responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: success: true properties: key: type: string description: "The key used to access the custom field" examples: example-1: value: success: true requestBody: content: application/json: schema: type: object properties: accessToken: $ref: '#/components/parameters/accessToken' customField: $ref: "#/components/schemas/CustomFieldCreate" required: - accessToken - customField patch: summary: Update Lead Custom Field description: "Supported for Salesforce and HubSpot" operationId: patch-lead-custom-field responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: success: true properties: key: type: string description: "The key used to access the custom field" examples: example-1: value: success: true requestBody: content: application/json: schema: type: object properties: accessToken: $ref: '#/components/parameters/accessToken' customField: $ref: "#/components/schemas/CustomFieldUpdate" required: - accessToken - customField /crm/lead/batch: get: summary: Get Batch Leads tags: - leads responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: leads: type: array items: $ref: "#/components/schemas/Lead" invalidIds: $ref: "#/components/schemas/InvalidIds" examples: example-1: value: leads: - id: v.lead.d08f345ace24509e911a0ea8e3d2203c nativeId: "23" firstName: Tom lastName: Smith jobTitle: Director of Operations email: tom@bluecross.com account: Blue Cross phone: "1234445555" mobilePhone: "2338889999" createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa additional: {} operationId: get-batch-crm-lead parameters: - schema: type: string in: query name: accessToken required: true description: The token for the customer's CRM account. This was generated when they connected their account. - schema: type: string in: query name: ids description: Comma separated list of Lead Id's. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve Leads by a set of Id's parameters: [] /crm/notes: get: summary: Get All Notes tags: - notes responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: notes: type: array items: $ref: "#/components/schemas/Note" nextPageCursor: type: string examples: example-1: value: notes: - id: v.note.006b4db16b6b50c981a174b02753c390 nativeId: "34" content: This note has some interesting content in it! modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: get-all-crm-notes description: Retrieve all Notes parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: cursor - schema: type: number in: query name: limit description: The number of records to return per page. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response /crm/notes/search: post: summary: Search Notes tags: - notes requestBody: content: application/json: schema: type: object properties: filters: type: object properties: id: $ref: "#/components/schemas/StringFilter" nativeId: $ref: "#/components/schemas/StringFilter" content: $ref: "#/components/schemas/StringFilter" contentText: $ref: "#/components/schemas/StringFilter" contentHtml: $ref: "#/components/schemas/StringFilter" createdTime: $ref: "#/components/schemas/DateFilter" modifiedTime: $ref: "#/components/schemas/DateFilter" responses: "200": description: OK content: application/json: schema: type: object properties: notes: type: array items: $ref: "#/components/schemas/Note" nextPageCursor: type: string title: responseBody examples: example-1: value: notes: - id: v.note.006b4db16b6b50c981a174b02753c390 nativeId: "34" content: This note has some interesting content in it! modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: search-crm-notes description: Search all Notes using filters parameters: - $ref: '#/components/parameters/accessToken' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/allFields' /crm/note: get: summary: Get Note tags: - notes responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: note: $ref: "#/components/schemas/Note" examples: example-1: value: note: id: v.note.006b4db16b6b50c981a174b02753c390 nativeId: "34" content: This note has some interesting content in it! modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-one-crm-note parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: id required: true - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve a single Note by Id post: summary: Create Note tags: - notes operationId: post-crm-note responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string note: $ref: "#/components/schemas/NoteCreate" required: - accessToken - note examples: example-1: value: accessToken: string note: content: This note has some interesting content in it! ownerUserId: v.user.79d154aa0c7a571295a157369d448e65 dealId: v.deal.497fb529e6805351b5dc8057c74a4a52 leadId: v.lead.d08f345ace24509e911a0ea8e3d2203c accountId: v.account.0dcb45e051315a6ea63b0f16e73689d9 contactId: v.contact.e5f32d4fd2115220bd20a2ccf81210ec description: "" description: |- Create a new Note. *CRM Caveats*: - Salesforce: You may only associate a Note with one entity. patch: summary: Update Note tags: - notes operationId: put-crm-note responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string id: type: string note: $ref: "#/components/schemas/NoteUpdate" required: - accessToken - id - note examples: example-1: value: accessToken: string id: string note: content: This note has some interesting content in it! ownerUserId: v.user.79d154aa0c7a571295a157369d448e65 description: Update an existing Note by Id /crm/note/details: get: summary: Get Note Details tags: - notes responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: fields: type: array items: $ref: "#/components/schemas/Field" nextPageCursor: type: string examples: example-1: value: fields: - key: content name: Content type: string options: null isArray: false custom: false universal: true required: true creatable: true updatable: true nextPageCursor: string operationId: get-details-crm-note description: |- Get details about all notes. Details include the type, possible values, and other meta data about the fields. parameters: - schema: type: string in: query name: accessToken description: "The token for the customer's CRM account. This was generated when they connected their account." required: true - schema: type: string in: query name: cursor - schema: type: boolean in: query name: allFields description: "Returns details about native fields." /crm/note/batch: get: summary: Get Batch Notes tags: - notes responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: notes: type: array items: $ref: "#/components/schemas/Note" invalidIds: $ref: "#/components/schemas/InvalidIds" examples: example-1: value: notes: - id: v.note.006b4db16b6b50c981a174b02753c390 nativeId: "34" content: This note has some interesting content in it! modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-batch-crm-note parameters: - schema: type: string in: query name: accessToken required: true description: The token for the customer's CRM account. This was generated when they connected their account. - schema: type: string in: query name: ids description: Comma separated list of Note Id's. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve Notes by a set of Id's parameters: [] /crm/tasks: get: summary: Get All Tasks tags: - tasks responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: tasks: type: array items: $ref: "#/components/schemas/Task" nextPageCursor: type: string examples: example-1: value: tasks: - id: v.task.2322707bbc41577d9806400e2daa25de nativeId: "122" body: This task needs to be done very soon! subject: High Priority Task isDone: false dueDate: "2019-09-24T14:15:22Z" status: Not Done priority: High modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: get-all-crm-tasks description: Retrieve all Tasks parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: cursor - schema: type: number in: query name: limit description: The number of records to return per page. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response parameters: [] /crm/tasks/search: post: summary: Search Tasks tags: - tasks requestBody: content: application/json: schema: type: object properties: filters: type: object properties: id: $ref: "#/components/schemas/StringFilter" nativeId: $ref: "#/components/schemas/StringFilter" body: $ref: "#/components/schemas/StringFilter" subject: $ref: "#/components/schemas/StringFilter" dueDate: $ref: "#/components/schemas/DateFilter" priority: $ref: "#/components/schemas/StringFilter" status: $ref: "#/components/schemas/StringFilter" isDone: $ref: "#/components/schemas/BooleanFilter" ownerUserId: $ref: "#/components/schemas/StringFilter" createdTime: $ref: "#/components/schemas/DateFilter" modifiedTime: $ref: "#/components/schemas/DateFilter" responses: "200": description: OK content: application/json: schema: type: object properties: tasks: type: array items: $ref: "#/components/schemas/Task" nextPageCursor: type: string title: responseBody examples: example-1: value: tasks: - id: v.task.2322707bbc41577d9806400e2daa25de nativeId: "122" body: This task needs to be done very soon! subject: High Priority Task isDone: false dueDate: "2019-09-24T14:15:22Z" status: Not Done priority: High ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: search-crm-tasks description: Search all Tasks using filters parameters: - $ref: '#/components/parameters/accessToken' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/allFields' /crm/task: get: summary: Get Task tags: - tasks responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: task: $ref: "#/components/schemas/Task" examples: example-1: value: task: id: v.task.2322707bbc41577d9806400e2daa25de nativeId: "122" body: This task needs to be done very soon! subject: High Priority Task isDone: false dueDate: "2019-09-24T14:15:22Z" status: Not Done priority: High modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-one-crm-task parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: id required: true - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve a single Task by Id post: summary: Create Task tags: - tasks operationId: post-crm-task responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string task: $ref: "#/components/schemas/TaskCreate" required: - accessToken examples: example-1: value: accessToken: string task: body: This task needs to be done very soon! subject: High Priority Task dueDate: "2019-09-24T14:15:22Z" isDone: false ownerUserId: v.user.79d154aa0c7a571295a157369d448e65 leadId: v.lead.d08f345ace24509e911a0ea8e3d2203c dealId: v.deal.497fb529e6805351b5dc8057c74a4a52 accountId: v.account.0dcb45e051315a6ea63b0f16e73689d9 contactId: v.contact.e5f32d4fd2115220bd20a2ccf81210ec priority: High status: Not Done description: "" description: |- Create a new Task. *CRM Caveats*: - Salesforce: You may only associate a Task with either a Lead or a Contact *and* either a Deal or an Account. patch: summary: Update Task tags: - tasks operationId: put-crm-task responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string id: type: string task: $ref: "#/components/schemas/TaskUpdate" required: - accessToken - id - task examples: example-1: value: accessToken: string id: string task: body: This task needs to be done very soon! subject: High Priority Task dueDate: "2019-09-24T14:15:22Z" isDone: false ownerUserId: v.user.79d154aa0c7a571295a157369d448e65 priority: High status: Not Done description: Update an existing Task by Id parameters: [] /crm/task/details: get: summary: Get Task Details tags: - tasks responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: fields: type: array items: $ref: "#/components/schemas/Field" nextPageCursor: type: string examples: example-1: value: fields: - key: subject name: Subject type: string options: null isArray: false custom: false universal: true required: false creatable: true updatable: true nextPageCursor: string operationId: get-details-crm-task description: |- Get details about all tasks. Details include the type, possible values, and other meta data about the fields. parameters: - schema: type: string in: query name: accessToken description: "The token for the customer's CRM account. This was generated when they connected their account." required: true - schema: type: string in: query name: cursor - schema: type: boolean in: query name: allFields description: "Returns details about native fields." /crm/task/batch: get: summary: Get Batch Tasks tags: - tasks responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: tasks: type: array items: $ref: "#/components/schemas/Task" invalidIds: $ref: "#/components/schemas/InvalidIds" examples: example-1: value: tasks: - id: v.task.2322707bbc41577d9806400e2daa25de nativeId: "122" body: This task needs to be done very soon! subject: High Priority Task isDone: false dueDate: "2019-09-24T14:15:22Z" status: Not Done priority: High modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-batch-crm-task parameters: - schema: type: string in: query name: accessToken required: true description: The token for the customer's CRM account. This was generated when they connected their account. - schema: type: string in: query name: ids description: Comma separated list of Task Id's. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve Tasks by a set of Id's parameters: [] /crm/events: get: summary: Get All Events tags: - events responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: events: type: array items: $ref: "#/components/schemas/Event" nextPageCursor: type: string examples: example-1: value: events: - id: v.event.0000d2e83d6c5d52a61f2fb860666477 nativeId: "19" subject: Meeting with Blue Cross description: Going to get tea with Tom from Blue Cross to discuss his paper needs type: Meeting location: 1122 Tea Dr startDateTime: "2019-08-24T14:15:22Z" endDateTime: "2019-08-24T14:15:22Z" isAllDayEvent: true createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: get-all-crm-events description: Retrieve all Events parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. - schema: type: string in: query name: cursor - schema: type: number in: query name: limit description: The number of records to return per page. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response /crm/events/search: post: summary: Search Events tags: - events requestBody: content: application/json: schema: type: object properties: filters: type: object properties: id: $ref: "#/components/schemas/StringFilter" nativeId: $ref: "#/components/schemas/StringFilter" subject: $ref: "#/components/schemas/StringFilter" description: $ref: "#/components/schemas/StringFilter" type: $ref: "#/components/schemas/StringFilter" location: $ref: "#/components/schemas/StringFilter" endDateTime: $ref: "#/components/schemas/DateFilter" startDateTime: $ref: "#/components/schemas/DateFilter" isAllDayEvent: $ref: "#/components/schemas/BooleanFilter" createdTime: $ref: "#/components/schemas/DateFilter" modifiedTime: $ref: "#/components/schemas/DateFilter" responses: "200": description: OK content: application/json: schema: type: object properties: events: type: array items: $ref: "#/components/schemas/Event" nextPageCursor: type: string title: responseBody examples: example-1: value: events: - id: v.event.0000d2e83d6c5d52a61f2fb860666477 nativeId: "19" subject: Meeting with Blue Cross description: Going to get tea with Tom from Blue Cross to discuss his paper needs type: Meeting location: 1122 Tea Dr startDateTime: "2019-08-24T14:15:22Z" endDateTime: "2019-08-24T14:15:22Z" isAllDayEvent: true createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: search-crm-events description: Search all Events using filters parameters: - $ref: '#/components/parameters/accessToken' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/allFields' /crm/event: get: summary: Get Event tags: - events responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: event: $ref: "#/components/schemas/Event" examples: example-1: value: event: id: v.event.0000d2e83d6c5d52a61f2fb860666477 nativeId: "19" subject: Meeting with Blue Cross description: Going to get tea with Tom from Blue Cross to discuss his paper needs type: Meeting location: 1122 Tea Dr startDateTime: "2019-08-24T14:15:22Z" endDateTime: "2019-08-24T14:15:22Z" isAllDayEvent: true createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-one-crm-event parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: id required: true - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve a single Event by Id post: summary: Create Event tags: - events operationId: post-crm-event responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string event: $ref: "#/components/schemas/EventCreate" required: - accessToken examples: example-1: value: accessToken: string event: subject: Meeting with Blue Cross description: Going to get tea with Tom from Blue Cross to discuss his paper needs type: Meeting location: 1122 Tea Dr startDateTime: "2019-08-24T14:15:22Z" endDateTime: "2019-08-24T14:15:22Z" isAllDayEvent: true dealId: v.deal.497fb529e6805351b5dc8057c74a4a52 accountId: v.account.0dcb45e051315a6ea63b0f16e73689d9 contactId: v.contact.e5f32d4fd2115220bd20a2ccf81210ec leadId: v.lead.d08f345ace24509e911a0ea8e3d2203c ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 description: "" description: Create a new Event. patch: summary: Update Event tags: - events operationId: put-crm-event responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string id: type: string event: $ref: "#/components/schemas/EventUpdate" required: - accessToken - id - event examples: example-1: value: accessToken: string id: string event: subject: Meeting with Blue Cross description: Going to get tea with Tom from Blue Cross to discuss his paper needs type: Meeting location: 1122 Tea Dr startDateTime: "2019-08-24T14:15:22Z" endDateTime: "2019-08-24T14:15:22Z" isAllDayEvent: true ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 description: Update an existing Event by Id parameters: [] /crm/event/details: get: summary: Get Event Details tags: - events responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: fields: type: array items: $ref: "#/components/schemas/Field" nextPageCursor: type: string examples: example-1: value: fields: - key: subject name: Subject type: string options: null isArray: false custom: false universal: true required: false creatable: true updatable: true nextPageCursor: string operationId: get-details-crm-event description: |- Get details about all events. Details include the type, possible values, and other meta data about the fields. parameters: - schema: type: string in: query name: accessToken description: "The token for the customer's CRM account. This was generated when they connected their account." required: true - schema: type: string in: query name: cursor - schema: type: boolean in: query name: allFields description: "Returns details about native fields." /crm/event/batch: get: summary: Get Batch Events tags: - events responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: events: type: array items: $ref: "#/components/schemas/Event" invalidIds: $ref: "#/components/schemas/InvalidIds" examples: example-1: value: events: - id: v.event.0000d2e83d6c5d52a61f2fb860666477 nativeId: "19" subject: Meeting with Blue Cross description: Going to get tea with Tom from Blue Cross to discuss his paper needs type: Meeting location: 1122 Tea Dr startDateTime: "2019-08-24T14:15:22Z" endDateTime: "2019-08-24T14:15:22Z" isAllDayEvent: true createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-batch-crm-event parameters: - schema: type: string in: query name: accessToken required: true description: The token for the customer's CRM account. This was generated when they connected their account - schema: type: string in: query name: ids description: Comma separated list of Event Id's. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response. description: Retrieve Events by a set of Id's parameters: [] /crm/event/attendees: get: summary: Get All Event Attendees tags: - attendees responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: eventAttendees: type: array items: $ref: "#/components/schemas/EventAttendee" nextPageCursor: type: string examples: example-1: value: eventAttendees: - id: v.attendee.f63c1bd7215f5150b332d31d9509752f associatedObjectType: Contact status: Confirmed email: null createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: eventId: v.event.0000d2e83d6c5d52a61f2fb860666477 associationId: fbdb8b1e827609f50c25b4d52a7b6f57 additional: {} nextPageCursor: string operationId: get-all-crm-event-attendees description: Retrieve all Attendees for all Events parameters: - schema: type: string in: query description: The token for the customer's CRM account. This was generated when they connected their account. name: accessToken - schema: type: string in: query name: cursor - schema: type: number in: query name: limit description: The number of records to return per page. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response /crm/event/attendees/search: post: summary: Search Event Attendees tags: - attendees requestBody: content: application/json: schema: type: object properties: filters: type: object properties: id: $ref: "#/components/schemas/StringFilter" nativeId: $ref: "#/components/schemas/StringFilter" email: $ref: "#/components/schemas/StringFilter" status: $ref: "#/components/schemas/StringFilter" associatedObjectType: $ref: "#/components/schemas/StringFilter" createdTime: $ref: "#/components/schemas/DateFilter" modifiedTime: $ref: "#/components/schemas/DateFilter" responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: eventAttendees: type: array items: $ref: "#/components/schemas/EventAttendee" nextPageCursor: type: string examples: example-1: value: eventAttendees: - id: v.attendee.f63c1bd7215f5150b332d31d9509752f associatedObjectType: Contact status: Confirmed email: null createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: eventId: v.event.0000d2e83d6c5d52a61f2fb860666477 associationId: fbdb8b1e827609f50c25b4d52a7b6f57 additional: {} nextPageCursor: string operationId: search-crm-event-attendees description: Search all Event Attendees using filters parameters: - $ref: '#/components/parameters/accessToken' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/allFields' /crm/event/attendee: get: summary: Get Event Attendee tags: - attendees responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: eventAttendee: $ref: "#/components/schemas/EventAttendee" examples: example-1: value: eventAttendee: id: v.attendee.f63c1bd7215f5150b332d31d9509752f associatedObjectType: Contact status: Confirmed email: null createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: eventId: v.event.0000d2e83d6c5d52a61f2fb860666477 associationId: fbdb8b1e827609f50c25b4d52a7b6f57 additional: {} operationId: get-one-crm-event-attendee parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: id required: true - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve a single Event Attendee by Id parameters: [] post: summary: Create Event Attendee tags: - attendees operationId: post-crm-event-attendee responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: accessToken: type: string eventAttendee: $ref: "#/components/schemas/EventAttendeeCreate" examples: example-1: value: accessToken: string eventAttendee: email: null associatedObjectType: Contact status: Declined associationId: 98201f83c3f1c36dbcb36804c572c3ca eventId: v.event.0000d2e83d6c5d52a61f2fb860666477 description: Add an Attendee to an Event patch: summary: Update Event Attendee tags: - attendees operationId: put-crm-event-attendee responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: accessToken: type: string id: type: string eventAttendee: $ref: "#/components/schemas/EventAttendeeUpdate" required: - accessToken - id - eventAttendee examples: example-1: value: accessToken: string eventAttendee: status: Declined description: Update the status of an event attendee /crm/event/attendee/details: get: summary: Get Event Attendee Details tags: - attendees responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: fields: type: array items: $ref: "#/components/schemas/Field" nextPageCursor: type: string examples: example-1: value: fields: - key: email name: Email type: email options: null isArray: false custom: false universal: true required: false creatable: true updatable: true nextPageCursor: string operationId: get-details-crm-event-attendee description: |- Get details about all event attendees. Details include the type, possible values, and other meta data about the fields. parameters: - schema: type: string in: query name: accessToken description: "The token for the customer's CRM account. This was generated when they connected their account." required: true - schema: type: string in: query name: cursor - schema: type: boolean in: query name: allFields description: "Returns details about native fields." /crm/event/attendee/batch: get: summary: Get Batch Event Attendees tags: - attendees responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: eventAttendees: type: array items: $ref: "#/components/schemas/EventAttendee" invalidIds: $ref: "#/components/schemas/InvalidIds" examples: example-1: value: eventAttendees: - id: v.attendee.f63c1bd7215f5150b332d31d9509752f associatedObjectType: Contact status: Confirmed email: null createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: eventId: v.event.0000d2e83d6c5d52a61f2fb860666477 associationId: fbdb8b1e827609f50c25b4d52a7b6f57 additional: {} operationId: get-batch-crm-event-attendee parameters: - schema: type: string in: query name: accessToken required: true description: The token for the customer's CRM account. This was generated when they connected their account. - schema: type: string in: query name: ids description: Comma separated list of Event Attendee Id's. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve Event Attendees by a set of Id's parameters: [] /crm/emails: get: summary: Get All Emails tags: - emails responses: "200": description: OK content: application/json: schema: type: object properties: emails: type: array items: $ref: "#/components/schemas/Email" nextPageCursor: type: string title: responseBody examples: example-1: value: emails: - id: v.email.3ab3a9562af957228c1019127e3c81e1 nativeId: "23" from: michael@dunder.mifflin to: - greg@bluecross.com cc: - betty@bluecross.com bcc: - carl@bluecross.com subject: BlueCross <> Dunder Mifflin body: Hi Greg, need any paper? - Michael bodyHtml:

Hi Greg, need any paper? - Michael

messageDate: "2019-08-24T14:15:22Z" isIncoming: false isBounced: false hasAttachment: false status: SENT createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: get-all-crm-emails description: "Retrieve all Emails" parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: cursor - schema: type: number in: query name: limit description: The number of records to return per page. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response parameters: [] /crm/emails/search: post: summary: Search Emails tags: - emails requestBody: content: application/json: schema: type: object properties: filters: type: object properties: id: $ref: "#/components/schemas/StringFilter" nativeId: $ref: "#/components/schemas/StringFilter" from: $ref: "#/components/schemas/StringFilter" to: $ref: "#/components/schemas/StringListFilter" cc: $ref: "#/components/schemas/StringListFilter" bcc: $ref: "#/components/schemas/StringListFilter" subject: $ref: "#/components/schemas/StringFilter" body: $ref: "#/components/schemas/StringFilter" bodyHtml: $ref: "#/components/schemas/StringFilter" messageDate: $ref: "#/components/schemas/DateFilter" isIncoming: $ref: "#/components/schemas/BooleanFilter" isBounced: $ref: "#/components/schemas/BooleanFilter" hasAttachment: $ref: "#/components/schemas/BooleanFilter" status: $ref: "#/components/schemas/StringFilter" createdTime: $ref: "#/components/schemas/DateFilter" modifiedTime: $ref: "#/components/schemas/DateFilter" responses: "200": description: OK content: application/json: schema: type: object properties: emails: type: array items: $ref: "#/components/schemas/Email" nextPageCursor: type: string title: responseBody examples: example-1: value: emails: - id: v.email.3ab3a9562af957228c1019127e3c81e1 nativeId: "23" from: michael@dunder.mifflin to: - greg@bluecross.com cc: - betty@bluecross.com bcc: - carl@bluecross.com subject: BlueCross <> Dunder Mifflin body: Hi Greg, need any paper? - Michael bodyHtml:

Hi Greg, need any paper? - Michael

messageDate: "2019-08-24T14:15:22Z" isIncoming: false isBounced: false hasAttachment: false status: SENT createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: search-crm-emails description: Search all Emails using filters parameters: - $ref: '#/components/parameters/accessToken' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/allFields' /crm/email: get: summary: Get Email tags: - emails responses: "200": description: OK content: application/json: schema: type: object properties: email: $ref: "#/components/schemas/Email" title: responseBody examples: example-1: value: email: id: v.email.3ab3a9562af957228c1019127e3c81e1 nativeId: "23" from: michael@dunder.mifflin to: - greg@bluecross.com cc: - betty@bluecross.com bcc: - carl@bluecross.com subject: BlueCross <> Dunder Mifflin body: Hi Greg, need any paper? - Michael bodyHtml:

Hi Greg, need any paper? - Michael

messageDate: "2019-08-24T14:15:22Z" isIncoming: false isBounced: false hasAttachment: false status: SENT createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-one-crm-email parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: id required: true - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve a single Task by Id post: summary: Create Email tags: - emails operationId: post-crm-email responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string email: $ref: "#/components/schemas/EmailCreate" required: - accessToken examples: example-1: value: accessToken: string email: from: michael@dunder.mifflin to: - greg@bluecross.com cc: - betty@bluecross.com bcc: - carl@bluecross.com subject: BlueCross <> Dunder Mifflin body: Hi Greg, need any paper? - Michael bodyHtml:

Hi Greg, need any paper? - Michael

messageDate: "2019-08-24T14:15:22Z" isIncoming: false status: SENT accountId: v.account.0dcb45e051315a6ea63b0f16e73689d9 dealId: v.deal.497fb529e6805351b5dc8057c74a4a52 leads: - id: v.lead.d08f345ace24509e911a0ea8e3d2203c role: to contacts: - id: v.contact.e5f32d4fd2115220bd20a2ccf81210ec role: cc ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} description: "" description: |- Create a new Email. patch: summary: Update Email tags: - emails operationId: put-crm-email responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string id: type: string email: $ref: "#/components/schemas/EmailUpdate" required: - accessToken - id - email examples: example-1: value: accessToken: string id: string email: isIncoming: false status: SENT ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} description: |- Update an Email by Id. *CRM Caveats*: - Pipedrive: Not supported. parameters: [] /crm/email/details: get: summary: Get Email Details tags: - emails responses: "200": description: OK content: application/json: schema: type: object properties: fields: type: array items: $ref: "#/components/schemas/Field" nextPageCursor: type: string title: responseBody examples: example-1: value: fields: - key: email name: Email type: email options: null isArray: false custom: false universal: true required: false creatable: true updatable: true nextPageCursor: string operationId: get-details-crm-email description: |- Get details about all emails. Details include the type, possible values, and other meta data about the fields. parameters: - schema: type: string in: query name: accessToken description: "The token for the customer's CRM account. This was generated when they connected their account." required: true - schema: type: string in: query name: cursor - schema: type: boolean in: query name: allFields description: "Returns details about native fields." /crm/email/batch: get: summary: Get Batch Emails tags: - emails responses: "200": description: OK content: application/json: schema: type: object properties: emails: type: array items: $ref: "#/components/schemas/Email" invalidIds: $ref: "#/components/schemas/InvalidIds" title: responseBody examples: example-1: value: email: id: v.email.3ab3a9562af957228c1019127e3c81e1 nativeId: "23" from: michael@dunder.mifflin to: - greg@bluecross.com cc: - betty@bluecross.com bcc: - carl@bluecross.com subject: BlueCross <> Dunder Mifflin body: Hi Greg, need any paper? - Michael bodyHtml:

Hi Greg, need any paper? - Michael

messageDate: "2019-08-24T14:15:22Z" isIncoming: false isBounced: false hasAttachment: false status: SENT createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-batch-crm-email parameters: - schema: type: string in: query name: accessToken required: true description: The token for the customer's CRM account. This was generated when they connected their account. - schema: type: string in: query name: ids description: Comma separated list of Email Id's. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve Email by a set of Id's parameters: [] /crm/calls: get: summary: Get All Calls responses: "200": description: OK content: application/json: schema: type: object properties: calls: type: array items: $ref: "#/components/schemas/Call" nextPageCursor: type: string title: responseBody examples: example-1: value: calls: - id: v.call.3ab3a9562af957228c1019127e3c81e1 nativeId: "23" subject: BlueCross <> Dunder Mifflin disposition: "ANSWERED" direction: "inbound" description: "Call from Greg" date: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: get-all-crm-calls description: "Retrieve all Calls" parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: cursor - schema: type: number in: query name: limit description: The number of records to return per page. - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response parameters: [] /crm/calls/search: post: summary: Search Calls requestBody: content: application/json: schema: type: object properties: filters: type: object properties: id: $ref: "#/components/schemas/StringFilter" nativeId: $ref: "#/components/schemas/StringFilter" disposition: $ref: "#/components/schemas/StringFilter" direction: $ref: "#/components/schemas/StringFilter" subject: $ref: "#/components/schemas/StringFilter" description: $ref: "#/components/schemas/StringFilter" date: $ref: "#/components/schemas/DateFilter" status: $ref: "#/components/schemas/StringFilter" duration: $ref: "#/components/schemas/NumberFilter" from: $ref: "#/components/schemas/StringFilter" to: $ref: "#/components/schemas/StringFilter" recordingUrl: $ref: "#/components/schemas/StringFilter" createdTime: $ref: "#/components/schemas/DateFilter" modifiedTime: $ref: "#/components/schemas/DateFilter" responses: "200": description: OK content: application/json: schema: type: object properties: calls: type: array items: $ref: "#/components/schemas/Call" nextPageCursor: type: string title: responseBody examples: example-1: value: calls: - id: v.call.3ab3a9562af957228c1019127e3c81e1 nativeId: "23" subject: BlueCross <> Dunder Mifflin disposition: "ANSWERED" direction: "inbound" description: "Call from Greg" date: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} nextPageCursor: string operationId: search-crm-calls description: Search all Calls using filters parameters: - $ref: '#/components/parameters/accessToken' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/allFields' /crm/call: get: summary: Get Call responses: "200": description: OK content: application/json: schema: type: object properties: call: $ref: "#/components/schemas/Call" title: responseBody examples: example-1: value: call: id: v.call.3ab3a9562af957228c1019127e3c81e1 nativeId: "23" subject: BlueCross <> Dunder Mifflin disposition: "ANSWERED" direction: "inbound" description: "Call from Greg" date: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-one-crm-call parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string in: query name: id required: true - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve a single Call by Id post: summary: Create Call operationId: post-crm-call responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string call: $ref: "#/components/schemas/CallCreate" required: - accessToken examples: example-1: value: accessToken: string call: subject: BlueCross <> Dunder Mifflin disposition: "ANSWERED" direction: "inbound" description: "Call from Greg" date: "2019-08-24T14:15:22Z" accountId: v.account.0dcb45e051315a6ea63b0f16e73689d9 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} description: "" description: |- Create a new Call. patch: summary: Update Call operationId: put-crm-call responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object x-examples: example-1: id: "0" properties: id: type: string required: - id examples: example-1: value: id: "0" requestBody: content: application/json: schema: type: object properties: accessToken: type: string id: type: string call: $ref: "#/components/schemas/CallUpdate" required: - accessToken - id - call examples: example-1: value: accessToken: string id: string call: ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 disposition: "ANSWERED" additional: {} description: |- Update an Call by Id. parameters: [] /crm/call/details: get: summary: Get Call Details responses: "200": description: OK content: application/json: schema: type: object properties: fields: type: array items: $ref: "#/components/schemas/Field" nextPageCursor: type: string title: responseBody examples: example-1: value: fields: - key: subject name: Subject type: string options: null isArray: false custom: false universal: true required: false creatable: true updatable: true nextPageCursor: string operationId: get-details-crm-call description: |- Get details about all Calls. Details include the type, possible values, and other meta data about the fields. parameters: - schema: type: string in: query name: accessToken description: "The token for the customer's CRM account. This was generated when they connected their account." required: true - schema: type: string in: query name: cursor - schema: type: boolean in: query name: allFields description: "Returns details about native fields." /crm/call/batch: post: summary: Batch Calls responses: "200": description: OK content: application/json: schema: type: object properties: calls: type: array items: $ref: "#/components/schemas/Call" invalidIds: $ref: "#/components/schemas/InvalidIds" title: responseBody examples: example-1: value: call: id: v.call.3ab3a9562af957228c1019127e3c81e1 nativeId: "23" subject: BlueCross <> Dunder Mifflin disposition: "ANSWERED" direction: "inbound" description: "Call from Greg" date: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} operationId: get-batch-crm-call requestBody: content: application/json: schema: type: object properties: accessToken: type: string description: The token for the customer's CRM account. This was generated when they connected their account. ids: type: array items: string description: List of call Ids. allFields: type: boolean description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response required: - accessToken - ids examples: example-1: value: accessToken: string ids: ['v.call.abc', 'v.call.xyz'] description: Retrieve Call by a set of Id's parameters: [] /crm/lists: get: summary: Get All Lists tags: - lists responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: lists: type: array items: $ref: "#/components/schemas/ListWithoutAssociations" nextPageCursor: type: string examples: example-1: value: lists: - id: 006b4db16b6b50c981a174b02753c390 nativeId: "34" name: California Leads modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" nextPageCursor: string operationId: get-all-crm-lists description: Retrieve all Lists parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string enum: - contact - lead in: query name: objectType description: The object type for the Lists required: true - schema: type: string in: query name: cursor - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response /crm/list: get: summary: Get List tags: - lists responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: list: $ref: "#/components/schemas/ListWithAssociations" nextPageCursor: type: string examples: example-1: value: list: - id: 006b4db16b6b50c981a174b02753c390 nativeId: "34" name: California Leads modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: - contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec - v.contact.2d20a2ccf81210ecddf32d4fd2115221 nextPageCursor: string operationId: get-one-crm-list parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. required: true - schema: type: string enum: - contact - lead in: query name: objectType description: The object type for the Lists required: true - schema: type: string in: query name: id required: true - schema: type: string in: query name: cursor description: Provide the `nextPageCursor` value from the previous request to retrieve the next set of ids - schema: type: boolean in: query name: allFields description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response description: Retrieve a single List by Id /crm/passthrough: post: summary: Passthrough Request tags: - passthrough operationId: post-crm-passthrough responses: "200": description: OK content: application/json: schema: title: responseBody description: "" type: object properties: headers: type: object url: type: string description: The full URL that the request was sent to. statusCode: type: number description: The HTTP status code of the response from the downstream CRM. body: AnyValue: description: The body of the response from the downstream CRM. required: - id examples: example-1: value: headers: content-type: application/json url: https://mydomain.my.salesforce.com/services/data/v53.0/sobjects/Account statusCode: 200 body: id: 0011A00001XQ4QSQAZ success: true requestBody: content: application/json: schema: type: object properties: accessToken: type: string method: type: string enum: - GET - POST - PUT - PATCH - DELETE path: type: string description: "The path to send the request to. Vessel handles the domain so for a request to Salesforce instead of using `https://mydomain.my.salesforce.com/services/data/v52.0/sobjects/Account` you would use `services/data/v52.0/sobjects/Account`." body: type: object description: "The body of the request." query: type: object description: "The query parameters to send with the request as key value pairs. These are appended to the URL when the request is sent to the CRM." required: - accessToken - method - path examples: example-1: value: accessToken: string method: PATCH path: services/data/v53.0/sobjects/Account/0011A00001XQ4ZUQA1 body: - Name: "Vessel" description: "" description: Send an authenticated passthrough request to the downstream CRM. This is useful for making requests to endpoints that are not yet supported by Vessel. /link/token: post: summary: Create Link Token tags: - tokens operationId: post-link-token responses: "200": description: Create link token content: application/json: schema: title: responseBody type: object properties: linkToken: type: string examples: {} description: "Generates a link token to be used during the authentication flow. This token is passed to either the Vessel Link Component or `useVesselLink` hook." security: - VesselAPIToken: [] parameters: [] /link/exchange: post: summary: Exchange Public Token for Access Token tags: - links operationId: post-link-exchange responses: "200": description: Exchange for access token content: application/json: schema: title: responseBody type: object properties: connectionId: type: string accessToken: type: string integrationId: type: string enum: - salesforce - hubspot - pipedrive - zoho - apollo - salesloft - outreach nativeOrgId: type: string description: Supported in HubSpot, Salesforce, and Pipedrive nativeUserId: type: string description: Supported in HubSpot, Salesforce, and Pipedrive nativeOrgURL: type: string required: - connectionId - accessToken - integrationId - nativeOrgId - nativeUserId - nativeOrgURL examples: {} description: Exchanges the public token for an access token used to interact with the account. Store the access token in a secure location. requestBody: content: application/json: schema: type: object properties: publicToken: type: string required: - publicToken security: - VesselAPIToken: [] parameters: [] /connection/connection: parameters: [] get: summary: Get Connection tags: - connections responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: connection: $ref: "#/components/schemas/Connection" operationId: get-one-connection description: Get info about a connection for a given accessToken. parameters: - schema: type: string in: query name: connectionId description: The ID of the connection for the customer's CRM account. This was generated when they connected their account. required: true delete: summary: Delete Connection tags: - connections operationId: delete-connection responses: '200': description: >- Remove a connection for a given `accessToken`. Removing a connection disconnects the user's CRM so they'll need to re-authenticate should they want to re-connect their CRM. requestBody: content: application/json: schema: type: object properties: connectionId: type: string required: - connectionId security: - VesselAPIToken: [] description: |- Remove a connection for a given `connectionId`. Removing a connection disconnects the user's CRM so they'll need to re-authenticate should they want to re-connect their CRM. /connection/crm/integrations: get: summary: Get CRM Integrations tags: - integrations responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: integrations: type: array items: $ref: "#/components/schemas/Integration" operationId: get-all-crm-integrations description: Return all of the CRM integrations supported by Vessel. parameters: [] parameters: [] /connection/connections: get: summary: Get All Connections tags: - connections responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: connections: type: array items: $ref: "#/components/schemas/Connection" operationId: get-all-crm-connections description: List all connections /connection/webhook: get: summary: Get Webhook tags: - webhooks responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: webhook: $ref: "#/components/schemas/WebhookMetadata" operationId: get-one-webhook description: Retrieve information about a webhook for a given connection and id parameters: - schema: type: string in: query name: accessToken description: The token for the customer's CRM account. This was generated when they connected their account. - schema: type: string in: query name: webhookId post: summary: Create Webhook tags: - webhooks operationId: post-webhook responses: "200": description: OK content: application/json: schema: title: responseBody type: object properties: webhook: $ref: "#/components/schemas/WebhookMetadata" description: Create a new webhook for a given connection requestBody: content: application/json: schema: type: object properties: accessToken: type: string webhook: $ref: "#/components/schemas/WebhookMetadataCreate" delete: summary: Remove Webhook tags: - webhooks operationId: delete-webhook responses: "200": description: OK description: Removes a webhook for a given connection and id requestBody: content: application/json: schema: type: object properties: accessToken: type: string webhookId: type: string components: schemas: InvalidIds: type: array items: type: string description: Ids that didn't return anything. Will be an empty array if all Ids are valid. User: title: User type: object description: "Users of the connected CRM platform. These are *not* the contacts or leads, but rather the user accounts from the connected CRM." examples: - id: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 nativeId: "12" firstName: Micheal lastName: Scott email: micheal@dundermifflin.com createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" archived: false additional: {} properties: id: type: string description: Unique Vessel Id. nativeId: type: string description: Id of the object in the connected CRM. firstName: type: string lastName: type: string email: format: email type: string createdTime: type: string description: The timestamp that the user was created modifiedTime: type: string description: The timestamp the user was last modified archived: type: boolean description: Whether or not the user is archived additional: type: object description: "Returned when `allFields` is set in the query params. Includes all data, untransformed, we received from the downstream CRM" required: - id - nativeId - createdTime - modifiedTime - associations Contact: title: Contact type: object examples: - id: v.contact.e5f32d4fd2115220bd20a2ccf81210ec nativeId: "23" email: tom@bluecross.com firstName: Tom lastName: Smith jobTitle: Director of Operations phone: "2101128833" mobilePhone: "2106541111" createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} description: "Information about an individual affiliated with another CRM Object (e.g., a Lead, a Deal, etc)" properties: id: type: string description: Unique Vessel Id. nativeId: type: string description: Id of the object in the connected CRM. email: type: string firstName: type: string lastName: type: string jobTitle: type: string description: Not supported by Pipedrive phone: type: string description: The primary phone number for this contact mobilePhone: type: string description: The primary mobile phone number for this contact. Possibly the same as the phone number. createdTime: type: string description: The timestamp that the contact was created modifiedTime: type: string description: The timestamp the contact was last modified associations: type: object required: - accountIds - dealIds - leadIds - noteIds - taskIds - eventIds - eventAttendeeIds - emailIds - callIds - ownerUserId properties: accountIds: type: array items: type: string dealIds: type: array items: type: string leadIds: type: array items: type: string noteIds: type: array items: type: string taskIds: type: array items: type: string eventIds: type: array items: type: string eventAttendeeIds: type: array items: type: string emailIds: type: array items: type: string callIds: type: array items: type: string ownerUserId: type: string additional: type: object description: "Returned when `allFields` is set in the query params. Includes all data, untransformed, we received from the downstream CRM" required: - id - nativeId - createdTime - modifiedTime - associations Address: title: Address type: object properties: street: type: string city: type: string state: type: string postalCode: type: string country: type: string examples: - street: 123 Main St city: San Francisco state: CA postalCode: 94105 country: US Deal: title: Deal type: object examples: - id: v.deal.497fb529e6805351b5dc8057c74a4a52 nativeId: "84" name: Blue Cross Deal stage: demo amount: 10000 closeDate: "2020-08-23T00:00:00Z" probability: "0.4" expectedRevenue: 4000 isWon: false isClosed: false modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} description: |- (Alias: Opportunity) An object representing either the opportunity to sell a product to an Account, or in the case of an `isWon` deal, a product sold to an Account. *CRM Caveats*: - Pipedrive: Users must have "Deal probability" turned on for the given pipeline for probability to be configurable and returned. properties: id: type: string description: Unique Vessel Id. nativeId: type: string description: Id of the object in the connected CRM. name: type: string description: Optional name for this deal stage: type: string description: The stage of the pipeline the deal is in. See /deal/details for possible values amount: type: number description: Total deal money value closeDate: type: string description: When this deal is projected to be closed probability: type: string description: Decimal probability of closing this deal. expectedRevenue: type: number description: probability * amount. This is a computed property isWon: type: boolean description: If this deal has been won. This is a computed property based on stage isClosed: type: boolean description: If this deal is closed (either closed-won or closed-lost). This is a computed property based on stage createdTime: type: string description: The timestamp that the deal was created modifiedTime: type: string description: The timestamp the deal was last modified associations: type: object required: - contactIds - accountIds - noteIds - taskIds - emailIds - callIds - ownerUserId properties: contactIds: type: array items: type: string accountIds: type: array items: type: string noteIds: type: array items: type: string taskIds: type: array items: type: string eventIds: type: array items: type: string emailIds: type: array items: type: string callIds: type: array items: type: string ownerUserId: type: string description: The Id of the User that owns this Deal additional: type: object description: "Returned when `allFields` is set in the query params. Includes all data, untransformed, we received from the downstream CRM" required: - id - nativeId - name - closeDate - createdTime - modifiedTime - associations Account: title: Account type: object examples: - id: v.account.0dcb45e051315a6ea63b0f16e73689d9 nativeId: "344" name: Blue Cross description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton industry: TV and Media annualRevenue: 10000000 numberOfEmployees: 100 website: www.bluecross.penn createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" phone: "8192223333" address: street: 100 Blue Dr city: Scranton state: Pennsylvania postalCode: "281332" country: USA associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} description: "(Alias: company, organization) An organization involved with your business." properties: id: type: string description: Unique Vessel Id. nativeId: type: string description: Id of the object in the connected CRM. name: type: string description: type: string description: A description of this Company/Account. Not supported by Pipedrive industry: type: string description: Not supported by Pipedrive annualRevenue: type: number description: Not supported by Pipedrive numberOfEmployees: type: number description: Not supported by Pipedrive website: type: string description: Not supported by Pipedrive phone: type: string description: The primary phone number. Not supported by Pipedrive address: $ref: "#/components/schemas/Address" createdTime: type: string description: The timestamp that the account was created modifiedTime: type: string description: The timestamp the account was last modified associations: type: object required: - dealIds - contactIds - noteIds - taskIds - leadIds - eventIds - emailIds - callIds - ownerUserId properties: dealIds: type: array items: type: string contactIds: type: array items: type: string noteIds: type: array items: type: string taskIds: type: array items: type: string leadIds: type: array items: type: string eventIds: type: array items: type: string emailIds: type: array items: type: string callIds: type: array items: type: string ownerUserId: type: string description: The Id of the User that owns this Account additional: type: object description: "Returned when `allFields` is set in the query params. Includes all data, untransformed, we received from the downstream CRM" required: - id - nativeId - createdTime - modifiedTime - associations Lead: title: Lead type: object description: |- A Lead represents an individual, or sometimes an organization, that is interested in purchasing your product (i.e., is a potential Deal). *CRM Caveats*: - HubSpot: we consider contacts with the `leadStatus` set to be leads. examples: - id: v.lead.d08f345ace24509e911a0ea8e3d2203c nativeId: "23" firstName: Tom lastName: Smith jobTitle: Director of Operations email: tom@bluecross.com account: Blue Cross phone: "1234445555" mobilePhone: "2338889999" createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 noteIds: - v.note.006b4db16b6b50c981a174b02753c390 taskIds: - v.task.2322707bbc41577d9806400e2daa25de eventIds: - v.event.0000d2e83d6c5d52a61f2fb860666477 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f emailIds: - v.email.3ab3a9562af957228c1019127e3c81e1 callIds: - v.call.1222707bbc415ee4806400e2daa25ffa additional: {} properties: id: type: string description: Unique Vessel Id. nativeId: type: string description: Id of the object in the connected CRM. firstName: type: string lastName: type: string jobTitle: type: string email: type: string account: type: string description: Name of the Account associated with this lead phone: type: string description: The primary phone mobilePhone: type: string description: The primary mobile phone number for this lead. Possibly the same as the phone number createdTime: type: string description: The timestamp that the lead was created modifiedTime: type: string description: The timestamp the lead was last modified associations: type: object required: - contactIds - accountIds - noteIds - taskIds - eventIds - eventAttendeeIds - emailIds - callIds properties: contactIds: type: array items: type: string accountIds: type: array items: type: string noteIds: type: array items: type: string taskIds: type: array items: type: string eventIds: type: array items: type: string eventAttendeeIds: type: array items: type: string emailIds: type: array items: type: string callIds: type: array items: type: string additional: type: object description: "Returned when `allFields` is set in the query params. Includes all data, untransformed, we received from the downstream CRM" required: - id - nativeId - createdTime - modifiedTime - associations Note: title: Note type: object description: "A Note attached to some CRM Object. " examples: - id: v.note.006b4db16b6b50c981a174b02753c390 nativeId: "34" content: This note has some interesting content in it! modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} properties: id: type: string description: Unique Vessel Id. nativeId: type: string description: Id of the object in the connected CRM. contentHtml: type: string description: The body of the note (populated if CRM notes support html) contentText: type: string description: The body of the note (populated if CRM notes only support plaintext) createdTime: type: string description: The timestamp that the note was created modifiedTime: type: string description: The timestamp the note was last modified associations: type: object required: - dealIds - contactIds - accountIds - leadIds - ownerUserId properties: dealIds: type: array items: type: string contactIds: type: array items: type: string accountIds: type: array items: type: string leadIds: type: array items: type: string ownerUserId: type: string description: The Id of the User that owns this note additional: type: object description: "Returned when `allFields` is set in the query params. Includes all data, untransformed, we received from the downstream CRM" required: - id - nativeId - createdTime - modifiedTime - associations Task: title: Task type: object description: A task attached to some CRM object examples: - id: v.task.2322707bbc41577d9806400e2daa25de nativeId: "122" body: This task needs to be done very soon! subject: High Priority Task isDone: false dueDate: "2019-09-24T14:15:22Z" status: Not Done priority: High modifiedTime: "2019-08-24T14:15:22Z" createdTime: "2019-08-24T14:15:22Z" associations: dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} properties: id: type: string description: Unique Vessel Id. nativeId: type: string description: Id of the object in the connected CRM. body: type: string subject: type: string isDone: type: boolean dueDate: type: string status: type: string description: Not supported by Pipedrive priority: type: string description: Not supported by Pipedrive createdTime: type: string description: The timestamp that the task was created modifiedTime: type: string description: The timestamp the task was last modified associations: type: object required: - dealIds - contactIds - accountIds - leadIds - ownerUserId properties: dealIds: type: array items: type: string contactIds: type: array items: type: string accountIds: type: array items: type: string leadIds: type: array items: type: string ownerUserId: type: string description: The Id of the User that owns this Task additional: type: object description: "Returned when `allFields` is set in the query params. Includes all data, untransformed, we received from the downstream CRM" required: - id - nativeId - createdTime - modifiedTime - associations Event: title: Event type: object description: |- Events are a type of activity that has attendees and takes place at a certain point in time (i.e., has a start and end date). For the currently supported CRMs, these are the objects Events most closely maps to: - Salesforce = Events - HubSpot = Meetings - Pipedrive = Activities - Zoho = Events examples: - id: v.event.0000d2e83d6c5d52a61f2fb860666477 nativeId: "19" subject: Meeting with Blue Cross description: Going to get tea with Tom from Blue Cross to discuss his paper needs type: Meeting location: 1122 Tea Dr startDateTime: "2019-08-24T14:15:22Z" endDateTime: "2019-08-24T14:15:22Z" isAllDayEvent: true createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 eventAttendeeIds: - v.attendee.f63c1bd7215f5150b332d31d9509752f ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} properties: id: type: string description: Unique Vessel Id. nativeId: type: string description: Id of the object in the connected CRM. subject: type: string description: type: string type: type: string location: type: string description: Where this event takes place. Can be virtual startDateTime: type: string endDateTime: type: string isAllDayEvent: type: boolean createdTime: type: string description: The timestamp that the event was created modifiedTime: type: string description: The timestamp the event was last modified associations: type: object required: - accountIds - leadIds - contactIds - dealIds - eventAttendeeIds - ownerUserId properties: accountIds: type: array items: type: string leadIds: type: array items: type: string contactIds: type: array items: type: string dealIds: type: array items: type: string eventAttendeeIds: type: array items: type: string ownerUserId: type: string description: The Id of the User that owns this event additional: type: object description: "Returned when `allFields` is set in the query params. Includes all data, untransformed, we received from the downstream CRM" required: - id - nativeId - createdTime - modifiedTime - associations EventAttendee: title: EventAttendee type: object description: "Event Attendees hold information about someone who attendeed or was invited to an event. Attendees are always associated with some Event and another person object such as a Contact, Lead, or Other." examples: - id: v.attendee.f63c1bd7215f5150b332d31d9509752f associatedObjectType: Contact status: Confirmed email: null createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: eventId: v.event.0000d2e83d6c5d52a61f2fb860666477 associationId: v.contact.e5f32d4fd2115220bd20a2ccf81210ec additional: {} properties: id: type: string description: Unique Vessel Id. nativeId: type: string description: Id of the object in the connected CRM. status: type: string associatedObjectType: type: string description: "The object type of the associated object (e.g., Contact, Lead, etc) or Other if this Attendee is not associated with a CRM object" email: type: string description: Optional unless `associationId` is null createdTime: type: string description: The timestamp that the event attendee was created modifiedTime: type: string description: The timestamp the event attendee was last modified associations: type: object required: - eventId - associationId properties: eventId: type: string associationId: type: string description: "The id of the associated object, if this Attendee is not associated with a CRM object, this id is null and the `email` field will be present" additional: type: object description: "Returned when `allFields` is set in the query params. Includes all data, untransformed, we received from the downstream CRM" required: - id - nativeId - associatedObjectType - createdTime - modifiedTime - associations Field: title: Field type: object description: |- (Alias: property) A field is a key-value pair on a CRM Object that provides information about that object. properties: key: type: string description: "The key in the CRM object (ex: annualRevenue, numberOfEmployees, etc)" name: type: string description: "The display name of this field (ex: number of employees, annual revenue, etc)" type: type: string enum: - string - number - datetime - date - boolean - reference - phone - url - id - email - percent - singleselect - multiselect - address - decimal - time - daterange - object options: type: array description: Possible options for this field items: type: object properties: key: oneOf: - type: string - type: number name: type: string isArray: type: boolean description: If this field is an array custom: type: boolean description: If this field is a custom field universal: type: boolean description: If this is a field we've unified across CRMs required: type: boolean description: If this field is required when creating the object creatable: type: boolean description: If this field can be used when creating the object updatable: type: boolean description: If this field can be updated required: - key - name - type - custom - universal - required - creatable - updatable examples: - key: numberOfEmployees name: number of employees type: number options: null isArray: false custom: false universal: true required: false creatable: true updatable: true Email: title: Email type: object description: |- An email is a message sent from one person to another through an email service. Emails involve participants - the person who the email was sent to, or the person that sent it. Participants are usually a Contact, Lead, or User but in certain CRMs, can be a person not yet associated with a CRM object. examples: - id: v.email.3ab3a9562af957228c1019127e3c81e1 nativeId: "23" from: michael@dunder.mifflin to: - greg@bluecross.com cc: - betty@bluecross.com bcc: - carl@bluecross.com subject: BlueCross <> Dunder Mifflin body: Hi Greg, need any paper? - Michael bodyHtml:

Hi Greg, need any paper? - Michael

messageDate: "2019-08-24T14:15:22Z" isIncoming: false isBounced: false hasAttachment: false status: SENT createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" associations: accountIds: - v.account.0dcb45e051315a6ea63b0f16e73689d9 leadIds: - v.lead.d08f345ace24509e911a0ea8e3d2203c contactIds: - v.contact.e5f32d4fd2115220bd20a2ccf81210ec dealIds: - v.deal.497fb529e6805351b5dc8057c74a4a52 ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} properties: id: type: string description: Unique Vessel Id. nativeId: type: string description: Id of the object in the connected CRM. from: type: string description: The email address that sent the email to: type: array description: The email addresses that received the email items: type: string cc: type: array description: The email addresses that received a copy of the email items: type: string bcc: type: array description: The email addresses that received a blind copy of the email items: type: string subject: type: string description: The subject of the email body: type: string description: The text formatted body of the email bodyHtml: type: string description: The html formatted body of the email messageDate: type: string description: The date the email was created. This can be set when creating the email object and is not necessarily the same as the `createdTime` field. isIncoming: type: boolean description: If this email was sent to the user or sent by the user isBounced: type: boolean description: If this email was bounced hasAttachment: type: boolean description: If this email has attachment(s) status: type: string description: The status of the email (CRM specific, see /details). createdTime: type: string description: The timestamp that the email object was created modifiedTime: type: string description: The timestamp the email object was last modified associations: type: object required: - accountIds - leadIds - contactIds - dealIds - ownerUserId properties: accountIds: type: array items: type: string leadIds: type: array items: type: string contactIds: type: array items: type: string dealIds: type: array items: type: string ownerUserId: type: string description: The Id of the User that owns this email additional: type: object description: "Returned when `allFields` is set in the query params. Includes all data, untransformed, we received from the downstream CRM" required: - id - nativeId - from - to - subject - createdTime - modifiedTime - associations Call: title: Call type: object properties: id: type: string description: Unique Vessel Id. nativeId: type: string description: Id of the object in the connected CRM. subject: type: string disposition: type: string description: Possibly an enum, See /details endpoint for values. direction: type: string enum: - inbound - outbound - internal description: type: string date: type: string description: The date the call occurred status: type: string description: Possibly an enum, See /details endpoint for values. duration: type: integer description: The duration of the call. to: type: string description: |- The phone number that was called. *CRM Caveats* Only supported for HubSpot. from: type: string description: |- The phone number called from. *CRM Caveats* Only supported for HubSpot. recordingUrl: type: string description: |- The URL of the recording of the call. *CRM Caveats* Only supported for HubSpot. createdTime: type: string description: The timestamp that the call object was created modifiedTime: type: string description: The timestamp the call object was last modified associations: type: object required: - accountIds - leadIds - contactIds - dealIds - ownerUserId properties: accountIds: type: array items: type: string contactIds: type: array items: type: string dealIds: type: array items: type: string leadIds: type: array items: type: string ownerUserId: type: string description: The Id of the User that owns this call additional: type: object StringFilter: type: object properties: equals: type: string contains: type: string startsWith: type: string endsWith: type: string not: type: string in: type: array items: type: string notIn: type: array items: type: string mode: type: string enum: - insensitive BooleanFilter: type: object properties: equals: type: boolean not: type: boolean NumberFilter: type: object properties: equals: type: number gt: type: number lt: type: number lte: type: number gte: type: number not: type: number in: type: array items: type: number notIn: type: array items: type: number StringListFilter: type: object properties: has: type: string hasEvery: type: array items: type: string hasSome: type: array items: type: string isEmpty: type: boolean DateFilter: type: object properties: equals: type: string gt: type: string lt: type: string lte: type: string gte: type: string not: type: string in: type: array items: type: string notIn: type: array items: type: string CallCreate: title: CallCreate type: object properties: subject: type: string disposition: type: string description: See /details endpoint for possible values. direction: type: string enum: - inbound - outbound - internal description: type: string date: type: string description: ISO Formatted date for when the call occurred status: type: string description: Possibly an enum, See /details endpoint for values. duration: type: integer description: The duration of the call. to: type: string description: |- The phone number that was called. *CRM Caveats* Only supported for HubSpot. from: type: string description: |- The phone number called from. *CRM Caveats* Only supported for HubSpot. recordingUrl: type: string description: |- The URL of the recording of the call. *CRM Caveats* Only supported for HubSpot. contactIds: type: array description: The participants involved in this call. If this is an inbound call, this is the contacts that called, if this is an outbound call, this is the contacts that were called. items: type: string accountId: type: string ownerUserId: type: string required: - disposition - direction - date CallUpdate: title: CallUpdate type: object properties: disposition: type: string description: See /details endpoint for possible values. ownerUserId: type: string required: - disposition EmailCreate: title: EmailCreate type: object description: "" examples: - from: michael@dunder.mifflin to: - greg@bluecross.com cc: - betty@bluecross.com bcc: - carl@bluecross.com subject: BlueCross <> Dunder Mifflin body: Hi Greg, need any paper? - Michael bodyHtml:

Hi Greg, need any paper? - Michael

messageDate: "2019-08-24T14:15:22Z" isIncoming: false status: SENT accountId: v.account.0dcb45e051315a6ea63b0f16e73689d9 dealId: v.deal.497fb529e6805351b5dc8057c74a4a52 leads: - id: v.lead.d08f345ace24509e911a0ea8e3d2203c role: to contacts: - id: v.contact.e5f32d4fd2115220bd20a2ccf81210ec role: cc ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} properties: from: type: string description: The email address that sent the email to: type: array description: The email addresses that received the email items: type: string cc: type: array description: The email addresses that received a copy of the email items: type: string bcc: type: array description: The email addresses that received a blind copy of the email items: type: string subject: type: string description: The subject of the email body: type: string description: The text formatted body of the email bodyHtml: type: string description: The html formatted body of the email messageDate: type: string description: The date the email was created. This can be set when creating the email object and is not necessarily the same as the `createdTime` field. isIncoming: type: boolean description: If this email was sent to the user or sent by the user status: type: string description: The status of the email (CRM specific, see /details). accountId: type: string dealId: type: string lead: type: object description: Associated Leads must participate in the email (i.e., have a role). properties: id: type: string role: enum: - from - to - cc - bcc contact: type: object description: Associated Contacts must participate in the email (i.e., have a role). properties: id: type: string role: enum: - from - to - cc - bcc ownerUserId: type: string description: The Id of the User that owns this email additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." required: - from - to - subject EmailUpdate: title: EmailUpdate type: object description: "" examples: - isIncoming: false status: SENT ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 additional: {} properties: isIncoming: type: boolean description: If this email was sent to the user or sent by the user status: type: string description: The status of the email (CRM specific, see /details). ownerUserId: type: string description: The Id of the User that owns this email additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." EventAttendeeCreate: title: EventAttendeeCreate type: object description: "" examples: - email: null associatedObjectType: Contact status: Declined associationId: 98201f83c3f1c36dbcb36804c572c3ca eventId: v.event.0000d2e83d6c5d52a61f2fb860666477 properties: email: type: string description: 'Required if associationId is not present and the CRM supports "Other" for attendee associatedObjectType ' associatedObjectType: type: string description: "The object type of the associated object (e.g., Contact, Lead, etc) or Other if this Attendee is not associated with a CRM object" status: type: string associationId: type: string description: Required unless email is present and CRM supports "Other" for associatedObjectType eventId: type: string additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." required: - associatedObjectType - eventId EventAttendeeUpdate: title: EventAttendeeUpdate type: object properties: status: type: string examples: - status: Declined description: "" EventCreate: title: EventCreate type: object description: "" properties: subject: type: string description: type: string type: type: string location: type: string startDateTime: type: string endDateTime: type: string isAllDayEvent: type: boolean description: Not supported by HubSpot and Pipedrive dealId: type: string accountId: type: string contactId: type: string leadId: type: string ownerUserId: type: string additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." required: - startDateTime - endDateTime examples: - subject: Meeting with Blue Cross description: Going to get tea with Tom from Blue Cross to discuss his paper needs type: Meeting location: 1122 Tea Dr startDateTime: "2019-08-24T14:15:22Z" endDateTime: "2019-08-24T14:15:22Z" isAllDayEvent: true dealId: v.deal.497fb529e6805351b5dc8057c74a4a52 accountId: v.account.0dcb45e051315a6ea63b0f16e73689d9 contactId: v.contact.e5f32d4fd2115220bd20a2ccf81210ec leadId: v.lead.d08f345ace24509e911a0ea8e3d2203c ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 EventUpdate: title: EventUpdate type: object properties: subject: type: string description: type: string type: type: string location: type: string startDateTime: type: string endDateTime: type: string isAllDayEvent: type: boolean description: Not supported by HubSpot and Pipedrive ownerUserId: type: string additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." examples: - subject: Meeting with Blue Cross description: Going to get tea with Tom from Blue Cross to discuss his paper needs type: Meeting location: 1122 Tea Dr startDateTime: "2019-08-24T14:15:22Z" endDateTime: "2019-08-24T14:15:22Z" isAllDayEvent: true ownerUserId: v.user.56f653659ea9524b9e0fb0ba67e6f8a0 TaskCreate: title: TaskCreate type: object description: "" examples: - body: This task needs to be done very soon! subject: High Priority Task dueDate: "2019-09-24T14:15:22Z" isDone: false ownerUserId: v.user.79d154aa0c7a571295a157369d448e65 leadId: v.lead.d08f345ace24509e911a0ea8e3d2203c dealId: v.deal.497fb529e6805351b5dc8057c74a4a52 accountId: v.account.0dcb45e051315a6ea63b0f16e73689d9 contactId: v.contact.e5f32d4fd2115220bd20a2ccf81210ec priority: High status: Not Done properties: body: type: string subject: type: string dueDate: type: string description: ISO Formatted Date for the due date of the task ownerUserId: type: string description: The user to assign this note to. If there is no ownerUserId provided, the behavior is defined by the downstream system (either assigned to no user or to the user that installed the app). leadId: type: string description: Can only set either leadId or dealId but not both. dealId: type: string description: Can only set either leadId or dealId but not both. accountId: type: string contactId: type: string priority: type: string description: Not supported by Pipedrive status: type: string description: Not supported by Pipedrive isDone: type: boolean description: "If both `isDone` and `status` are included, `isDone` will take precedence and automatically set `status` to either the default or a 'closed' status depending on the `isDone` value." additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." TaskUpdate: title: TaskUpdate type: object description: "" examples: - body: This task needs to be done very soon! subject: High Priority Task dueDate: "2019-09-24T14:15:22Z" isDone: false ownerUserId: v.user.79d154aa0c7a571295a157369d448e65 priority: High status: Not Done properties: body: type: string subject: type: string dueDate: type: string ownerUserId: type: string priority: type: string description: Not supported by Pipedrive status: type: string description: Not supported by Pipedrive isDone: type: boolean description: "If both `isDone` and `status` are included, `isDone` will take precedence and automatically set `status` to either the default or a 'closed' status depending on the `isDone` value." additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." ContactUpdate: title: ContactUpdate type: object examples: - email: tom@bluecross.com firstName: Tom lastName: Smith jobTitle: Director of Operations phone: "2101128833" mobilePhone: "2106541111" description: Update a Contact. properties: email: type: string firstName: type: string lastName: type: string jobTitle: type: string description: Not supported by Pipedrive phone: type: string description: The primary phone mobilePhone: type: string ownerUserId: type: string description: The Id of the User to assign this Contact to additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." ContactCreate: title: ContactCreate type: object examples: - email: tom@bluecross.com firstName: Tom lastName: Smith jobTitle: Director of Operations phone: "2101128833" mobilePhone: "2106541111" description: Properties that a contact can be created with properties: email: type: string firstName: type: string lastName: type: string jobTitle: type: string description: Not supported by Pipedrive phone: type: string description: The primary phone mobilePhone: type: string accountId: type: string description: The Id of the account to associate this contact with ownerUserId: type: string description: The Id of the User to assign this Contact to additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." required: - lastName DealUpdate: title: DealUpdate type: object examples: - name: Blue Cross Deal amount: 10000 closeDate: "2020-08-23T00:00:00Z" probability: "0.4" properties: name: type: string amount: type: number closeDate: type: string probability: type: string description: Decimal probability of closing the deal stage: type: string description: The stage the deal is in. See /deal/details for possible values accountId: type: string description: Update the account this deal is associated with. additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." required: - closeDate DealCreate: title: DealCreate type: object properties: name: type: string amount: type: number closeDate: type: string probability: type: string description: Decimal probability of closing the deal stage: type: string description: The stage the deal is in. See /deal/details for possible value accountId: type: string description: The Id of the account to associate this deal with contactId: type: string description: Only supported for Salesforce and HubSpot. The Id of the contact to associate this deal with additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." required: - name - closeDate AccountUpdate: title: AccountUpdate type: object examples: - name: Blue Cross description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton industry: TV and Media annualRevenue: 10000000 numberOfEmployees: 100 website: www.bluecross.penn createdTime: "2019-08-24T14:15:22Z" modifiedTime: "2019-08-24T14:15:22Z" phone: "8192223333" address: street: 100 Blue Dr city: Scranton state: Pennsylvania postalCode: "281332" country: USA properties: name: type: string description: type: string description: Not supported by Pipedrive industry: type: string description: Not supported by Pipedrive website: type: string description: Not supported by Pipedrive numberOfEmployees: type: number description: Not supported by Pipedrive annualRevenue: type: number description: Not supported by Pipedrive phone: type: string description: The primary phone| Not supported by Pipedrive address: $ref: "#/components/schemas/Address" ownerUserId: type: string description: The Id of the User to assign this Account to additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." required: - name AccountCreate: title: AccountCreate type: object examples: - name: Blue Cross description: Blue Cross of Pennsylvania is responsible for providing services to the good people of Scranton industry: TV and Media annualRevenue: 10000000 numberOfEmployees: 100 website: www.bluecross.penn phone: "8192223333" address: street: 100 Blue Dr city: Scranton state: Pennsylvania postalCode: "281332" country: USA properties: name: type: string description: type: string description: Not supported by Pipedrive industry: type: string description: Not supported by Pipedrive website: type: string description: Not supported by Pipedrive numberOfEmployees: type: number description: Not supported by Pipedrive annualRevenue: type: number description: Not supported by Pipedrive phone: type: string description: The primary phone | Not supported by Pipedrive ownerUserId: type: string description: The Id of the User to assign this Account to address: $ref: "#/components/schemas/Address" additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." required: - name NoteCreate: title: NoteCreate type: object description: Create a new Note. You may only associate a note with at most one entity of each type upon creation. examples: - content: This note has some interesting content in it! ownerUserId: v.user.79d154aa0c7a571295a157369d448e65 dealId: v.deal.497fb529e6805351b5dc8057c74a4a52 leadId: v.lead.d08f345ace24509e911a0ea8e3d2203c accountId: v.account.0dcb45e051315a6ea63b0f16e73689d9 contactId: v.contact.e5f32d4fd2115220bd20a2ccf81210ec properties: content: type: string description: The body of the note ownerUserId: type: string description: The user to assign this note to. If there is no ownerUserId provided, the behavior is defined by the downstream system (either assigned to no user or to the user that installed the app). dealId: type: string description: Required unless leadId/accountId/contactId are specified. leadId: type: string description: Required unless dealId/accountId/contactId are specified. accountId: type: string description: Required unless leadId/dealId/contactId are specified. contactId: type: string description: Required unless leadId/accountId/dealId are specified. additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." NoteUpdate: title: NoteUpdate type: object description: Update an existing Note. Please note that updating associations is not currently supported. examples: - content: This note has some interesting content in it! ownerUserId: v.user.79d154aa0c7a571295a157369d448e65 properties: content: type: string description: The body of the note ownerUserId: type: string description: Only Admins can change this property additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." LeadUpdate: description: "" type: object x-examples: example-1: firstName: string lastName: string jobTitle: string email: string phones: - value: "0001112222" type: Home modifiedTime: string createdTime: string examples: - firstName: Tom lastName: Smith jobTitle: Director of Operations email: tom@bluecross.com account: Blue Cross phone: "1234445555" mobilePhone: "2338889999" title: LeadUpdate properties: firstName: type: string description: Not supported for Pipedrive lastName: type: string description: Not supported for Pipedrive jobTitle: type: string email: type: string description: Not supported for Pipedrive account: type: string description: Name of the Account associated with this lead. Not supported for Pipedrive phone: type: string description: The primary phone. Not supported for Pipedrive mobilePhone: type: string description: The primary mobile phone number for this lead. Possibly the same as the phone number. Not supported for Pipedrive additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." LeadCreate: description: "" type: object x-examples: example-1: firstName: Tony lastName: Stark jobTitle: CEO email: tony@starkindustries.com phones: - value: "0001112222" type: Home examples: - firstName: Tom lastName: Smith jobTitle: Director of Operations email: tom@bluecross.com account: Blue Cross phone: "1234445555" mobilePhone: "2338889999" title: LeadCreate properties: firstName: type: string lastName: type: string jobTitle: type: string email: type: string account: type: string description: "Name of the Account associated with this lead. Not supported for Pipedrive. Defaults to `[TODO]: Fill in Company Name` in Salesforce" phone: type: string description: The primary phone number for this lead mobilePhone: type: string description: The primary mobile phone number for this lead. Possibly the same as the phone number. additional: type: object description: "Create any property in the downstream CRM, such as a custom or native property. For a list of all properties see /details." required: - lastName CustomFieldCreate: type: object description: "" properties: customKey: type: string description: "Used for overriding the default key generated from the name of the field. Not supported for Close" name: type: string type: type: string enum: - singleselect - number - text - currency - percentage options: type: array description: "Required when `type = singleselect`" items: type: object properties: name: type: string key: type: string required: - name - key required: - name - type CustomFieldUpdate: type: object description: "" properties: key: type: string options: type: array items: type: object properties: name: type: string key: type: string required: - name - key required: - key ListWithAssociations: title: List type: object description: "A List or View in a CRM" properties: id: type: string description: Id of the object. nativeId: type: string description: Id of the object in the connected CRM. name: type: string description: The name of the list createdTime: type: string description: The timestamp that the list was created modifiedTime: type: string description: The timestamp the list was last modified associations: type: object required: - contactIds - leadIds - ownerUserId properties: contactIds: type: array items: type: string leadIds: type: array items: type: string ownerUserId: type: string description: The Id of the User that owns this list additional: type: object description: "Returned when `allFields` is set in the query params. Includes all data, untransformed, we received from the downstream CRM" required: - id - nativeId - name - createdTime - modifiedTime - associations ListWithoutAssociations: title: List type: object description: "A List or View in a CRM" properties: id: type: string description: Id of the object. nativeId: type: string description: Id of the object in the connected CRM. name: type: string description: The name of the list createdTime: type: string description: The timestamp that the list was created modifiedTime: type: string description: The timestamp the list was last modified additional: type: object description: "Returned when `allFields` is set in the query params. Includes all data, untransformed, we received from the downstream CRM" required: - id - nativeId - name - createdTime - modifiedTime Integration: title: Integration type: object properties: integrationId: type: string enum: - salesforce - hubspot - pipedrive - zoho name: type: string iconURL: type: string description: Base 64 data URI examples: - integrationId: hubspot name: Hubspot iconURL: string WebhookMetadataCreate: title: WebhookMetadataCreate type: object description: Information describing a webhook properties: webhookUrl: type: string description: a valid URL WebhookMetadata: title: WebhookMetadata type: object properties: webhookId: type: string connectionId: type: string webhookUrl: type: string createdTime: type: string Connection: title: Connection type: object properties: integrationId: type: string enum: - salesforce - hubspot - pipedrive - zoho connectionId: type: string createdTime: type: string status: type: string enum: - NEW_CONNECTION - INITIAL_SYNCED - READY nativeOrgURL: type: string lastActivityDate: type: string examples: - connectionId: sample/eb97282c54ff6c5d9bdf4c716a01d6950c02d361183088769acbe302f94caf52 integrationId: hubspot createdTime: 2022-11-09T23:11:28.617Z status: READY, nativeOrgURL: https://app.hubspot.com lastActivityDate: 2022-11-10T00:00:00.000Z parameters: accessToken: name: accessToken in: query description: The token for the customer's account. This was generated when they connected their account. required: true schema: type: string id: name: id in: query description: The id of the object to retrieve required: true schema: type: string allFields: name: allFields in: query description: Returns all fields including non-unifiable and custom fields under the "additional" property in the response schema: type: boolean cursor: name: cursor in: query description: The cursor to use for pagination schema: type: string limit: name: limit in: query description: The number of records to return per page. schema: type: number securitySchemes: VesselAPIToken: name: vessel-api-token type: apiKey in: header security: - VesselAPIToken: []