Velaris Basic

Archive (remove) custom links from a risk

Archives a task by its ID, given in the request body as a positive integer - not the "srcid-"/"extid-" prefixed form used by the taskId path param on get_task/update_task.

Efficiently fetches up to 100 accounts in a single request. Use this instead of N individual GET calls when you already have a list of IDs.

Fetches up to 100 contacts in a single request. Supports lookup by internalId, externalId, or email address (set property="email").

Fetches up to 100 custom object instances in a single request. Supports lookup by internalId or externalId.

Fetches up to 100 opportunities in a single request.

Efficiently fetches up to 100 organizations in a single request. Use this instead of making N individual GET calls when you already have a list of organization IDs. Specify whether the IDs are internal ("internalId"), external ("externalId"), or email-based ("email") in the "property" field.

Fetch up to 100 risks by a set of internal IDs or external IDs in a single request. Not paginated - every matching risk is returned in a single flat `data` array.

Fetch up to 100 users by a set of internal IDs, external IDs, or email addresses in a single request.

Converts a monetary amount from one currency to another using the tenant's current exchange rates. `amount`, `fromCurrency`, and `toCurrency` are required.

Creates a new account. All tenant-defined fields are passed as `properties`. Optionally associate contacts, assign owners, set a lifecycle stage, and link to a parent organization using `organizationId` or `organizationExternalId`.

Create custom links for an account

Creates a new activity record. `title`, `activityType`, `source`, `sourceId`, `activityDateTime`, and `linkedEntities` (minimum 1) are required.

Creates a new contact. `email` is required and must be unique. Optionally associate the contact with accounts and organizations.

Create custom links for a contact

Creates a new instance of the specified custom object type. The request body must include all required fields defined in the object's schema. Pass `externalId` to enable external-ID-based lookups.

Create custom links for a custom object instance

Creates a new custom field definition for an entity type. `name`, `label`, `type`, and `entityType` are required. For `select` and `multiselect` types, supply the `options` array.

Creates a new note and attaches it to one or more entities. `title`, `body`, `source`, and `linkedEntities` (minimum 1) are required.

Creates a new opportunity. `properties.title` is required. The opportunity must be linked to an account or organization via `parentEntity`.

Create custom links for an opportunity

Creates a new organization. All tenant-defined fields are passed as `properties`. Optionally link contacts, assign owners, and set a lifecycle stage on creation.

Attach one or more custom links (relationships) to the specified organization. The `links` object is keyed by the target entity type's API name.

Creates a new risk. `properties.title` is required. The risk must be linked to an account or organization via `parentEntity`.

Create custom links for a risk

Creates a new task. `name`, `assignee`, and `activityTypeId` are required. Use `activityTypeId: 1` (General) when no `linkedEntity` is provided.

Creates a new support ticket. `title` is required.

Add a comment to a ticket

Delete an activity

Delete a note

Delete a ticket

Delete a ticket comment

Returns full details for a single account. Use "srcid-{id}" for internal IDs (e.g. "srcid-38") or "extid-{externalId}" for external IDs (e.g. "extid-bothive_1254"). If you only have a name, use search_accounts first to find the ID.

Get an activity by ID

Returns the tenant's configured base currency.

Returns full details for a single contact.

Returns full details for a single custom object instance.

Returns the exchange rates that were in effect for the specified month.

Get a note by ID

Returns full details for a single opportunity.