{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants External Contacts API", "version": "v2" }, "items": [ { "info": { "name": "External Contacts", "type": "folder" }, "items": [ { "info": { "name": "Bulk remove contacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/contacts/remove" }, "docs": "Bulk remove contacts" }, { "info": { "name": "Bulk add contacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/contacts/add" }, "docs": "Bulk add contacts" }, { "info": { "name": "Bulk fetch contacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/contacts" }, "docs": "Bulk fetch contacts" }, { "info": { "name": "Bulk update contacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/contacts/update" }, "docs": "Bulk update contacts" }, { "info": { "name": "Bulk fetch unresolved ancestor contacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/contacts/unresolved" }, "docs": "Bulk fetch unresolved ancestor contacts" }, { "info": { "name": "Bulk fetch contacts across divisions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/contacts/divisionviews" }, "docs": "Bulk fetch contacts across divisions" }, { "info": { "name": "Bulk Enrich Contacts - Run up to 10 Enrich operations per request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/contacts/enrich", "params": [ { "name": "dryRun", "value": "", "type": "query", "description": "If true, the request will not make any modifications, but will show you what the end result *would* be." } ] }, "docs": "See the API endpoint /externalcontacts/contacts/enrich for docs on individual Enrich operations." }, { "info": { "name": "Bulk remove notes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/notes/remove" }, "docs": "Bulk remove notes" }, { "info": { "name": "Bulk fetch notes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/notes" }, "docs": "Bulk fetch notes" }, { "info": { "name": "Bulk update notes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/notes/update" }, "docs": "Bulk update notes" }, { "info": { "name": "Bulk add notes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/notes/add" }, "docs": "Bulk add notes" }, { "info": { "name": "Bulk add organizations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/organizations/add" }, "docs": "Bulk add organizations" }, { "info": { "name": "Bulk remove organizations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/organizations/remove" }, "docs": "Bulk remove organizations" }, { "info": { "name": "Bulk fetch organizations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/organizations" }, "docs": "Bulk fetch organizations" }, { "info": { "name": "Bulk update organizations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/organizations/update" }, "docs": "Bulk update organizations" }, { "info": { "name": "Bulk fetch organizations across divisions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/organizations/divisionviews" }, "docs": "Bulk fetch organizations across divisions" }, { "info": { "name": "Bulk enrich external organizations - Run up to 10 Enrich operations per request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/organizations/enrich", "params": [ { "name": "dryRun", "value": "", "type": "query", "description": "If true, the request will not make any modifications, but will show you what the end result *would* be." } ] }, "docs": "See the API endpoint /externalcontacts/organizations/enrich for docs on individual Enrich operations." }, { "info": { "name": "Bulk remove relationships", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/relationships/remove" }, "docs": "Bulk remove relationships" }, { "info": { "name": "Bulk fetch relationships", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/relationships" }, "docs": "Bulk fetch relationships" }, { "info": { "name": "Bulk update relationships", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/relationships/update" }, "docs": "Bulk update relationships" }, { "info": { "name": "Bulk add relationships", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/bulk/relationships/add" }, "docs": "Bulk add relationships" }, { "info": { "name": "Fetch a note for an external contact", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId/notes/:noteId", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact Id" }, { "name": "noteId", "value": "", "type": "path", "description": "Note Id" }, { "name": "expand", "value": "", "type": "query", "description": "which fields, if any, to expand" } ] }, "docs": "Fetch a note for an external contact" }, { "info": { "name": "Update a note for an external contact", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId/notes/:noteId", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact Id" }, { "name": "noteId", "value": "", "type": "path", "description": "Note Id" } ] }, "docs": "Update a note for an external contact" }, { "info": { "name": "Update a Contact Note", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId/notes/:noteId", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact Id" }, { "name": "noteId", "value": "", "type": "path", "description": "Note Id" } ] }, "docs": "Update a Contact Note" }, { "info": { "name": "Delete a note for an external contact", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId/notes/:noteId", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact Id" }, { "name": "noteId", "value": "", "type": "path", "description": "Note Id" } ] }, "docs": "Delete a note for an external contact" }, { "info": { "name": "List notes for an external contact", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId/notes", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact Id" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size (limited to fetching first 1,000 records; pageSize <= 100; pageNumber * pageSize must be <= 1,000)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\"" }, { "name": "expand", "value": "", "type": "query", "description": "which fields, if any, to expand. mergeset will include notes attached to ancestor contacts which have been merged into this one." } ] }, "docs": "List notes for an external contact" }, { "info": { "name": "Create a note for an external contact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId/notes", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact Id" } ] }, "docs": "Create a note for an external contact" }, { "info": { "name": "Fetch an external contact", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact ID" }, { "name": "expand", "value": "", "type": "query", "description": "which fields, if any, to expand" } ] }, "docs": "Fetch an external contact" }, { "info": { "name": "Update an external contact", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact ID" } ] }, "docs": "Update an external contact" }, { "info": { "name": "Update specific fields of an external contact", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact ID" } ] }, "docs": "Update specific fields of an external contact" }, { "info": { "name": "Delete an external contact", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact ID" } ] }, "docs": "Delete an external contact" }, { "info": { "name": "Promote an observed contact (ephemeral or identified) to a curated contact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId/promotion", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact ID" } ] }, "docs": "Promote an observed contact (ephemeral or identified) to a curated contact" }, { "info": { "name": "List the identifiers for a contact", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId/identifiers", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact ID" } ] }, "docs": "List the identifiers for a contact" }, { "info": { "name": "Claim or release identifiers for a contact", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId/identifiers", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact ID" } ] }, "docs": "Claim or release identifiers for a contact" }, { "info": { "name": "Get a schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Get a schema" }, { "info": { "name": "Update a schema", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Update a schema" }, { "info": { "name": "Delete a schema", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Delete a schema" }, { "info": { "name": "Get a specific version of a schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/schemas/:schemaId/versions/:versionId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" }, { "name": "versionId", "value": "", "type": "path", "description": "Schema version" } ] }, "docs": "Get a specific version of a schema" }, { "info": { "name": "Get all versions of an external contact's schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/schemas/:schemaId/versions", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Get all versions of an external contact's schema" }, { "info": { "name": "Get a list of schemas.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/schemas" }, "docs": "Get a list of schemas." }, { "info": { "name": "Create a schema", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/schemas" }, "docs": "Create a schema" }, { "info": { "name": "Merge two contacts into a new contact record", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/merge/contacts" }, "docs": "Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details. Deprecated: This API has been superseded by a new merge API. You are encouraged to instead use /api/v2/externalcontacts/contacts/merge, which supports merging up to 25 Contacts of any type, and overriding specific fields in the resulting Contact." }, { "info": { "name": "Merge up to 25 contacts into a new contact record", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/merge" }, "docs": "Merge operation may fail if the resulting mergeset exceeds our default limit of 52. The valueOverride field lets you override any of the Contact fields post-merge. If any Contact field is left null in `valueOverride`, it will be taken from the most recently-modified contact in the merge set. Exception for *phone/*email fields: Conflicting data will be moved to any other available phone/email fields in the merged contact." }, { "info": { "name": "Search for external contacts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)" }, { "name": "q", "value": "", "type": "query", "description": "User supplied search keywords (no special syntax is currently supported)" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\"" }, { "name": "expand", "value": "", "type": "query", "description": "which fields, if any, to expand" }, { "name": "divisionIds", "value": "", "type": "query", "description": "which divisions to search, up to 50" } ] }, "docs": "Search for external contacts" }, { "info": { "name": "Create an external contact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts" }, "docs": "Create an external contact" }, { "info": { "name": "Scan for external contacts using paging", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/scan/contacts/divisionviews/all", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of contacts per page; must be between 10 and 200, default is 100" }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL" } ] }, "docs": "Scan for external contacts using paging" }, { "info": { "name": "Scan for external contacts using paging", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/scan/contacts", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of contacts per page; must be between 10 and 200, default is 100" }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL" }, { "name": "divisionId", "value": "", "type": "query", "description": "The division to scan over" } ] }, "docs": "Scan for external contacts using paging" }, { "info": { "name": "Associate/disassociate an external contact with a conversation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/externalcontacts/conversations/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" } ] }, "docs": "To associate, supply a value for the externalContactId. To disassociate, do not include the property at all." }, { "info": { "name": "Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/enrich", "params": [ { "name": "dryRun", "value": "", "type": "query", "description": "If true, the request will not make any modifications, but will show you what the end result *would* be." } ] }, "docs": "You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/contacts. A 201 response status indicates that a new Contact was created, whereas a 200 status indicates that a Contact was updated or a merge occurred." }, { "info": { "name": "Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/enrich", "params": [ { "name": "dryRun", "value": "", "type": "query", "description": "If true, the request will not make any modifications, but will show you what the end result *would* be." } ] }, "docs": "You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/organizations. A 201 response status indicates that a new External Organization was created, whereas a 200 status indicates that an External Organization was updated" }, { "info": { "name": "Search for external contacts in an external organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId/contacts", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization ID" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)" }, { "name": "q", "value": "", "type": "query", "description": "User supplied search keywords (no special syntax is currently supported)" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\"" }, { "name": "expand", "value": "", "type": "query", "description": "which fields, if any, to expand" } ] }, "docs": "Search for external contacts in an external organization" }, { "info": { "name": "List the identifiers for an external organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId/identifiers", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization ID" } ] }, "docs": "List the identifiers for an external organization" }, { "info": { "name": "Claim or release identifiers for an external organization", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId/identifiers", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization ID" } ] }, "docs": "Claim or release identifiers for an external organization" }, { "info": { "name": "Fetch a note for an external organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId/notes/:noteId", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization Id" }, { "name": "noteId", "value": "", "type": "path", "description": "Note Id" }, { "name": "expand", "value": "", "type": "query", "description": "which fields, if any, to expand" } ] }, "docs": "Fetch a note for an external organization" }, { "info": { "name": "Update a note for an external organization", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId/notes/:noteId", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization Id" }, { "name": "noteId", "value": "", "type": "path", "description": "Note Id" } ] }, "docs": "Update a note for an external organization" }, { "info": { "name": "Update an External Organization Note", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId/notes/:noteId", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization Id" }, { "name": "noteId", "value": "", "type": "path", "description": "Note Id" } ] }, "docs": "Update an External Organization Note" }, { "info": { "name": "Delete a note for an external organization", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId/notes/:noteId", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization Id" }, { "name": "noteId", "value": "", "type": "path", "description": "Note Id" } ] }, "docs": "Delete a note for an external organization" }, { "info": { "name": "List notes for an external organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId/notes", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization Id" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\"" }, { "name": "expand", "value": "", "type": "query", "description": "which fields, if any, to expand" } ] }, "docs": "List notes for an external organization" }, { "info": { "name": "Create a note for an external organization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId/notes", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization Id" } ] }, "docs": "Create a note for an external organization" }, { "info": { "name": "Fetch a relationship for an external organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId/relationships", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization ID" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)" }, { "name": "expand", "value": "", "type": "query", "description": "which fields, if any, to expand" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"relationship:desc\"" } ] }, "docs": "Fetch a relationship for an external organization" }, { "info": { "name": "Fetch an external organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization ID" }, { "name": "expand", "value": "", "type": "query", "description": "which fields, if any, to expand" }, { "name": "includeTrustors", "value": "", "type": "query", "description": "(true or false) whether or not to include trustor information embedded in the externalOrganization" } ] }, "docs": "Fetch an external organization" }, { "info": { "name": "Update an external organization", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization ID" } ] }, "docs": "Update an external organization" }, { "info": { "name": "Update specific fields of an external organization", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization ID" } ] }, "docs": "Update specific fields of an external organization" }, { "info": { "name": "Delete an external organization", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization ID" } ] }, "docs": "Delete an external organization" }, { "info": { "name": "Get a schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Get a schema" }, { "info": { "name": "Update a schema", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Update a schema" }, { "info": { "name": "Get a specific version of a schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/schemas/:schemaId/versions/:versionId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" }, { "name": "versionId", "value": "", "type": "path", "description": "Schema version" } ] }, "docs": "Get a specific version of a schema" }, { "info": { "name": "Get all versions of an external organization's schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/schemas/:schemaId/versions", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Get all versions of an external organization's schema" }, { "info": { "name": "Get a list of schemas.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/schemas" }, "docs": "Get a list of schemas." }, { "info": { "name": "Create a schema", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/schemas" }, "docs": "Create a schema" }, { "info": { "name": "Links a Trustor with an External Organization", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId/trustor/:trustorId", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization ID" }, { "name": "trustorId", "value": "", "type": "path", "description": "Trustor ID" } ] }, "docs": "Links a Trustor with an External Organization" }, { "info": { "name": "Unlink the Trustor for this External Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/:externalOrganizationId/trustor", "params": [ { "name": "externalOrganizationId", "value": "", "type": "path", "description": "External Organization ID" } ] }, "docs": "Unlink the Trustor for this External Organization" }, { "info": { "name": "Search for external organizations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)" }, { "name": "q", "value": "", "type": "query", "description": "Search query" }, { "name": "trustorId", "value": "", "type": "query", "description": "Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. \"companyType:asc\", \"industry:desc\"" }, { "name": "expand", "value": "", "type": "query", "description": "which fields, if any, to expand" }, { "name": "includeTrustors", "value": "", "type": "query", "description": "(true or false) whether or not to include trustor information embedded in the externalOrganization" }, { "name": "divisionIds", "value": "", "type": "query", "description": "which divisions to search, up to 50" } ] }, "docs": "Search for external organizations" }, { "info": { "name": "Create an external organization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations" }, "docs": "Create an external organization" }, { "info": { "name": "Scan for external organizations using paging", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/scan/organizations/divisionviews/all", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of organizations per page; must be between 10 and 200, default is 100" }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL" } ] }, "docs": "Scan for external organizations using paging" }, { "info": { "name": "Scan for external organizations using paging", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/scan/organizations", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of organizations per page; must be between 10 and 200, default is 100" }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL" }, { "name": "divisionId", "value": "", "type": "query", "description": "The division to scan over" } ] }, "docs": "Scan for external organizations using paging" }, { "info": { "name": "Fetch an External Source", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/externalsources/:externalSourceId", "params": [ { "name": "externalSourceId", "value": "", "type": "path", "description": "External Source ID" } ] }, "docs": "Fetch an External Source" }, { "info": { "name": "Update an External Source", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/externalcontacts/externalsources/:externalSourceId", "params": [ { "name": "externalSourceId", "value": "", "type": "path", "description": "External Source ID" } ] }, "docs": "Update an External Source" }, { "info": { "name": "Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/externalcontacts/externalsources/:externalSourceId", "params": [ { "name": "externalSourceId", "value": "", "type": "path", "description": "External Source ID" } ] }, "docs": "Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable." }, { "info": { "name": "Fetch a list of External Sources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/externalsources", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL" }, { "name": "limit", "value": "", "type": "query", "description": "The number of ExternalSources per page; must be between 10 and 200, default is 100" }, { "name": "name", "value": "", "type": "query", "description": "Filter by external source name. Filtering is prefix filtering and not an exact match" }, { "name": "active", "value": "", "type": "query", "description": "Filter by active status of external source" } ] }, "docs": "Fetch a list of External Sources" }, { "info": { "name": "Create an External Source", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/externalsources" }, "docs": "Create an External Source" }, { "info": { "name": "Fetch a contact using an identifier type and value.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/identifierlookup/contacts", "params": [ { "name": "expand", "value": "", "type": "query", "description": "which field, if any, to expand" } ] }, "docs": "Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: \"+1 704 298 4733\"" }, { "info": { "name": "Fetch an external organization using an identifier type and value.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/identifierlookup/organizations", "params": [ { "name": "expand", "value": "", "type": "query", "description": "which field, if any, to expand" } ] }, "docs": "This endpoint will only accept ExternalId type identifiers." }, { "info": { "name": "Fetch a contact using an identifier type and value.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/identifierlookup", "params": [ { "name": "expand", "value": "", "type": "query", "description": "which field, if any, to expand" } ] }, "docs": "NOTE: Deprecated. Please use /api/v2/externalcontacts/identifierlookup/contacts as an alternative endpoint instead. Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: \"+1 704 298 4733\"" }, { "info": { "name": "Retrieve segment assignments by external contact ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId/journey/segments", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact ID" }, { "name": "includeMerged", "value": "", "type": "query", "description": "Indicates whether to return segment assignments from all external contacts in the merge-set of the given one." }, { "name": "limit", "value": "", "type": "query", "description": "Number of entities to return. Default of 25, maximum of 500." } ] }, "docs": "Retrieve segment assignments by external contact ID." }, { "info": { "name": "Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned in the body for the client to retry, in the event of a partial success.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId/journey/segments", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact ID" } ] }, "docs": "Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned in the body for the client to retry, in the event of a partial success." }, { "info": { "name": "Retrieve all sessions for a given external contact.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId/journey/sessions", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact ID" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "includeMerged", "value": "", "type": "query", "description": "Indicates whether to return sessions from all external contacts in the merge-set of the given one." } ] }, "docs": "Retrieve all sessions for a given external contact." }, { "info": { "name": "Scan for notes using paging", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/scan/notes/divisionviews/all", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of notes per page; must be between 10 and 200, default is 100" }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL" } ] }, "docs": "Scan for notes using paging" }, { "info": { "name": "Scan for notes using paging", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/scan/notes", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of notes per page; must be between 10 and 200, default is 100" }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL" }, { "name": "divisionId", "value": "", "type": "query", "description": "The division to scan over" } ] }, "docs": "Scan for notes using paging" }, { "info": { "name": "Fetch a relationship", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/relationships/:relationshipId", "params": [ { "name": "relationshipId", "value": "", "type": "path", "description": "Relationship Id" }, { "name": "expand", "value": "", "type": "query", "description": "which fields, if any, to expand" } ] }, "docs": "Fetch a relationship" }, { "info": { "name": "Update a relationship", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/externalcontacts/relationships/:relationshipId", "params": [ { "name": "relationshipId", "value": "", "type": "path", "description": "Relationship Id" } ] }, "docs": "Update a relationship" }, { "info": { "name": "Update specific fields of a relationship", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/externalcontacts/relationships/:relationshipId", "params": [ { "name": "relationshipId", "value": "", "type": "path", "description": "Relationship Id" } ] }, "docs": "Update specific fields of a relationship" }, { "info": { "name": "Delete a relationship", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/externalcontacts/relationships/:relationshipId", "params": [ { "name": "relationshipId", "value": "", "type": "path", "description": "Relationship Id" } ] }, "docs": "Delete a relationship" }, { "info": { "name": "Create a relationship", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/relationships" }, "docs": "Create a relationship" }, { "info": { "name": "Scan for relationships", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/scan/relationships/divisionviews/all", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of relationships per page; must be between 10 and 200, default is 100" }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL" } ] }, "docs": "Scan for relationships" }, { "info": { "name": "Scan for relationships", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/scan/relationships", "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of relationships per page; must be between 10 and 200, default is 100" }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL" }, { "name": "divisionId", "value": "", "type": "query", "description": "The division to scan over" } ] }, "docs": "Scan for relationships" }, { "info": { "name": "Look up contacts based on an attribute. Maximum of 25 values returned.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/reversewhitepageslookup", "params": [ { "name": "lookupVal", "value": "", "type": "query", "description": "User supplied value to lookup contacts (supports email addresses, e164 phone numbers, Twitter screen names)" }, { "name": "expand", "value": "", "type": "query", "description": "which field, if any, to expand" }, { "name": "divisionId", "value": "", "type": "query", "description": "Specifies which division to lookup contacts in, for the given lookup value" } ] }, "docs": "Look up contacts based on an attribute. Maximum of 25 values returned." }, { "info": { "name": "Fetch an unresolved external contact", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/:contactId/unresolved", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "ExternalContact ID" }, { "name": "expand", "value": "", "type": "query", "description": "which fields, if any, to expand" } ] }, "docs": "Fetch an unresolved external contact" }, { "info": { "name": "Get a specific named core type.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/schemas/coretypes/:coreTypeName", "params": [ { "name": "coreTypeName", "value": "", "type": "path", "description": "Name of the core type" } ] }, "docs": "Get a specific named core type." }, { "info": { "name": "Get the core types from which all schemas are built.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/schemas/coretypes" }, "docs": "Get the core types from which all schemas are built." }, { "info": { "name": "Get quantitative limits on schemas", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/schemas/limits" }, "docs": "Get quantitative limits on schemas" }, { "info": { "name": "Get a specific named core type.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/schemas/coretypes/:coreTypeName", "params": [ { "name": "coreTypeName", "value": "", "type": "path", "description": "Name of the core type" } ] }, "docs": "Get a specific named core type." }, { "info": { "name": "Get the core types from which all schemas are built.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/schemas/coretypes" }, "docs": "Get the core types from which all schemas are built." }, { "info": { "name": "Get quantitative limits on schemas", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/schemas/limits" }, "docs": "Get quantitative limits on schemas" }, { "info": { "name": "Get export for exportId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/exports/:exportId", "params": [ { "name": "exportId", "value": "", "type": "path", "description": "Export id" } ] }, "docs": "Get export for exportId" }, { "info": { "name": "List contact exports for organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/exports", "params": [ { "name": "divisionIds", "value": "", "type": "query", "description": "Division IDs of entities" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return" } ] }, "docs": "List contact exports for organization" }, { "info": { "name": "Create bulk export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/contacts/exports" }, "docs": "Create bulk export" }, { "info": { "name": "Get notes export for exportId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/notes/exports/:exportId", "params": [ { "name": "exportId", "value": "", "type": "path", "description": "Export id" } ] }, "docs": "Get notes export for exportId" }, { "info": { "name": "List note exports for organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/notes/exports", "params": [ { "name": "divisionIds", "value": "", "type": "query", "description": "Division IDs of entities" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return" } ] }, "docs": "List note exports for organization" }, { "info": { "name": "Create notes export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/notes/exports" }, "docs": "Create notes export" }, { "info": { "name": "Get organizations export for exportId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/exports/:exportId", "params": [ { "name": "exportId", "value": "", "type": "path", "description": "Export id" } ] }, "docs": "Get organizations export for exportId" }, { "info": { "name": "List organization exports for organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/exports", "params": [ { "name": "divisionIds", "value": "", "type": "query", "description": "Division IDs of entities" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return" } ] }, "docs": "List organization exports for organization" }, { "info": { "name": "Create organizations export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/organizations/exports" }, "docs": "Create organizations export" }, { "info": { "name": "Get relationships export for exportId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/relationships/exports/:exportId", "params": [ { "name": "exportId", "value": "", "type": "path", "description": "Export id" } ] }, "docs": "Get relationships export for exportId" }, { "info": { "name": "List relationship exports for organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/relationships/exports", "params": [ { "name": "divisionIds", "value": "", "type": "query", "description": "Division IDs of entities" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return" } ] }, "docs": "List relationship exports for organization" }, { "info": { "name": "Create relationships export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/relationships/exports" }, "docs": "Create relationships export" }, { "info": { "name": "Get job based on id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/import/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Job id" }, { "name": "expand", "value": "", "type": "query", "description": "which fields, if any, to expand" } ] }, "docs": "Get job based on id" }, { "info": { "name": "Update Job's workflow status", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/externalcontacts/import/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Job id" } ] }, "docs": "Update Job's workflow status" }, { "info": { "name": "List jobs for organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/import/jobs", "params": [ { "name": "expand", "value": "", "type": "query", "description": "which fields, if any, to expand" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 100." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Direction of sorting." }, { "name": "jobStatus", "value": "", "type": "query", "description": "Search term to filter by jobStatus" } ] }, "docs": "List jobs for organization" }, { "info": { "name": "Create a new job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/import/jobs" }, "docs": "Create a new job" }, { "info": { "name": "Get setting based on id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/import/settings/:settingsId", "params": [ { "name": "settingsId", "value": "", "type": "path", "description": "Settings id" } ] }, "docs": "Get setting based on id" }, { "info": { "name": "Update settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/externalcontacts/import/settings/:settingsId", "params": [ { "name": "settingsId", "value": "", "type": "path", "description": "Settings id" } ] }, "docs": "Update settings" }, { "info": { "name": "Delete Settings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/externalcontacts/import/settings/:settingsId", "params": [ { "name": "settingsId", "value": "", "type": "path", "description": "Settings id" } ] }, "docs": "Delete Settings" }, { "info": { "name": "List settings for organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/import/settings", "params": [ { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 100." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Direction of sorting." }, { "name": "name", "value": "", "type": "query", "description": "Search term to filter by settings name" } ] }, "docs": "List settings for organization" }, { "info": { "name": "Create a new settings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/import/settings" }, "docs": "Create a new settings" }, { "info": { "name": "Create CSV import job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/import/csv/jobs" }, "docs": "Create CSV import job" }, { "info": { "name": "Get settings for CSV import", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/import/csv/settings/:settingsId", "params": [ { "name": "settingsId", "value": "", "type": "path", "description": "Settings id" } ] }, "docs": "Get settings for CSV import" }, { "info": { "name": "Update settings for CSV import", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/externalcontacts/import/csv/settings/:settingsId", "params": [ { "name": "settingsId", "value": "", "type": "path", "description": "Settings id" } ] }, "docs": "Update settings for CSV import" }, { "info": { "name": "Delete settings for CSV import", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/externalcontacts/import/csv/settings/:settingsId", "params": [ { "name": "settingsId", "value": "", "type": "path", "description": "Settings id" } ] }, "docs": "Delete settings for CSV import" }, { "info": { "name": "Retrieve all settings for organization filtered by externalSettingsId if provided", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/import/csv/settings", "params": [ { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "externalSettingsId", "value": "", "type": "query", "description": "External Settings Id to filter the list." } ] }, "docs": "Retrieve all settings for organization filtered by externalSettingsId if provided" }, { "info": { "name": "Create settings for CSV import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/import/csv/settings" }, "docs": "Create settings for CSV import" }, { "info": { "name": "Get details for CSV upload", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/import/csv/uploads/:uploadId/details", "params": [ { "name": "uploadId", "value": "", "type": "path", "description": "Upload id" } ] }, "docs": "Get details for CSV upload" }, { "info": { "name": "Get preview for CSV upload", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/externalcontacts/import/csv/uploads/:uploadId/preview", "params": [ { "name": "uploadId", "value": "", "type": "path", "description": "Upload id" } ] }, "docs": "Get preview for CSV upload" }, { "info": { "name": "Get url for CSV upload", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/externalcontacts/import/csv/uploads" }, "docs": "Get url for CSV upload" } ] } ], "bundled": true }