Vendasta

Creates a directional association between two CRM objects. The association type must be one of the fixed values with the correct direction (see the association type field description). Creating a duplicate association (same type, fromId, and toId) returns an ALREADY_EXISTS error (HTTP 409). Requires a valid Vendasta IAM bearer token.

CRMAssociationService_CreateAssociation

Creates a company in the given namespace. The request message is shared with the contact, opportunity, and custom-object create endpoints, so only company fields apply here. Set values in crmObject.fields, each naming the field by fieldId (or by externalId, which for built-ins takes the form standard__*); discover both from the field-schema list endpoint for object type Company. Omit crmObject.crmObjectId — the service assigns the id and returns it as crmObjectId in the response. Two fields behave differently here than their own documentation suggests: idempotencyId is accepted but not stored for this object type, so it cannot be relied on to deduplicate a retried create; and ownerId defaults to the calling user, so a service-account caller that omits it creates a record with no owner, which owner-scoped list and query calls then cannot see. Such a caller can set the owner explicitly by putting a user id, or that user's email address, in crmObject.ownerId, and a value resolving to no user fails with INVALID_ARGUMENT. A user-token caller behaves differently: ownerId is resolved as a user id only, an email is not accepted, and anything that fails to resolve falls back to the calling user with no error. Requires a valid Vendasta IAM bearer token.

CRMCompanyService_CreateCompany

Creates a contact in the given namespace. The request message is shared with the company, opportunity, and custom-object create endpoints, so only contact fields apply here. Set values in crmObject.fields, each naming the field by fieldId (or by externalId, which for built-ins takes the form standard__*); discover both from the field-schema list endpoint for object type Contact. Omit crmObject.crmObjectId — the service assigns the id and returns it as crmObjectId in the response. Two fields behave differently here than their own documentation suggests: idempotencyId is accepted but not stored for this object type, so it cannot be relied on to deduplicate a retried create; and ownerId defaults to the calling user, so a service-account caller that omits it creates a record with no owner, which owner-scoped list and query calls then cannot see. Such a caller can set the owner explicitly by putting a user id, or that user's email address, in crmObject.ownerId, and a value resolving to no user fails with INVALID_ARGUMENT. A user-token caller behaves differently: ownerId is resolved as a user id only, an email is not accepted, and anything that fails to resolve falls back to the calling user with no error. Requires a valid Vendasta IAM bearer token.

CRMService_CreateContact

Requires the standard__opportunity_pipeline_id field (get a valid pipeline id from the List Pipelines endpoint) and standard__opportunity_name. The opportunity stage (standard__opportunity_calculated_stage_id) cannot be set directly; it is calculated from the opportunity field values. To place a deal in a stage, set standard__opportunity_probability (a float from 0 to 1) so the opportunity matches that stage filter (see the pipeline stages); standard__opportunity_status is read-only and derived from probability (0 = Closed Lost, 1 = Closed Won, anything else = Open), and probability defaults to 0.1 when omitted. standard__opportunity_amount is a currency value. Discover the exact standard__ field external IDs via the field schema for object type Opportunity. ownerId defaults to the calling user, so a service-account caller that omits it creates an opportunity with no owner, which owner-scoped list and query calls then cannot see; such a caller can set the owner explicitly by putting a user id, or that user's email address, in crmObject.ownerId, and a value resolving to no user fails with INVALID_ARGUMENT. A user-token caller behaves differently: ownerId is resolved as a user id only, an email is not accepted, and anything that fails to resolve falls back to the calling user with no error. Requires a valid Vendasta IAM bearer token.

CRMOpportunityService_CreateOpportunity

Creates a pipeline that drives stage calculation for its object type (usually Opportunity). Provide stages in order; stageId should be omitted, it is assigned by the server on create. Each stage needs a name, a filterGroup with at least one filter and a valid filterGroupOperator, and mutations. A stage filterGroup determines membership from the object field values (for opportunities, typically standard__opportunity_status and standard__opportunity_probability, for example status Open with probability greater than 0.2 and at most 0.3). Stages should cover the probability range 0 to 1 with no gaps or overlaps. An object calculated stage is derived by matching its field values against these filters; the stage is never set directly on the object. Stage mutations are applied on stage entry and are required. Changing a pipeline affects stage calculation for every object in it. For opportunity pipelines, standard__opportunity_status is typically Open, Closed Won, or Closed Lost. Stage mutations must reference fields by fieldId, not externalId. Requires a valid Vendasta IAM bearer token.

Pipelines_CreatePipeline

Retrieves companies by id, including the field schemas for the fields present on them. Use fieldMask.paths to limit which fields are returned, naming each as a fields.<fieldId> path (fields.<externalId> is accepted too); a read mask requires the fields.<...> form, and a bare id matches nothing. A company's related contacts and opportunities are relationships held as associations, not fields on the company. Retrieve them from the association list endpoint, narrowing filtersV2 with a filter on field id association_type plus one naming the company: for value Contact-Company set field id to_id to the company id, and for value Company-Opportunity set field id from_id to the company id. These filter field ids are literal values, in snake_case, and are not camel-cased the way JSON property names are. Requires a valid Vendasta IAM bearer token.

CRMCompanyService_GetMultiCompany

Retrieves contacts by id, including the field schemas for the fields present on them. Use fieldMask.paths to limit which fields are returned, naming each as a fields.<fieldId> path (fields.<externalId> is accepted too); a read mask requires the fields.<...> form, and a bare id matches nothing. A contact's opportunities and companies are relationships held as associations, not fields on the contact. Retrieve them from the association list endpoint, narrowing filtersV2 with a filter on field id association_type (value Contact-Opportunity or Contact-Company) and one on field id from_id set to the contact id. These filter field ids are literal values, in snake_case, and are not camel-cased the way JSON property names are. The contact's primary company is additionally mirrored onto the standard__contact_primary_company_id field, but that field is a denormalized copy kept for filtering and covers only the primary company; the Contact-Company association remains the source of truth, so resolve or verify a contact's company through the association rather than the field alone. Requires a valid Vendasta IAM bearer token.

CRMService_GetMultiContact

Retrieves opportunities by id, including their field schemas. An opportunity related company and contact are associations, not fields, so use the association endpoints to resolve them. Requires a valid Vendasta IAM bearer token.

CRMOpportunityService_GetMultiOpportunity

Fetch the body of a Vendasta documentation page. Takes a file_id from search_docs results and returns that document's body rather than the search excerpt — typically the full page as published (raw HTML, often large). Documents over 512 KB are truncated, and the truncation is marked in the returned text. A file_id is a signed token produced by search_docs; no other form of identifier is accepted. Input: file_id (string, required) — file_id from a search_docs result

get_doc

Lists associations in a namespace. Use this to discover a record's relationships; for example an opportunity related company or contact is represented only as an association, not as a field on the opportunity. Requires a valid Vendasta IAM bearer token.

CRMAssociationService_ListAssociation