Link a CRM record to a partner

Tell Lasso which record on your side represents a partner.

Use this to send us the ID of the record on your side that represents the partner, when we don't otherwise know about it. Use it for a CRM object the flat hubspot_company_id-style fields on POST /partners don't cover, most often a custom object, and for any partner that already exists in Lasso (those fields only apply at creation).

For a partner represented by a custom CRM object, use object_type: custom_partner_object.

Once linked, the partner is addressable by your own ID via ?by=external&external_system_type=…&external_object_type=…, so you do not have to store a Lasso identifier on your side if you would rather not.

Semantics

A partner holds at most one record per (system_type, object_type). Sending a different identifier for a pair the partner already has replaces it; sending the same one again is a no-op and returns 200. If a different partner in your account already claims that record, the request is rejected with 409 rather than creating an ambiguous second claim.

The identifier is stored as supplied and is not verified against your CRM, so a wrong ID will be accepted and simply never match anything.

post/partners/{identifier}/external_ids

Request

Base URL: https://api.lassotech.com/api/v1/rest
URL: https://api.lassotech.com/api/v1/rest/partners/{identifier}/external_ids
Auth: API key in header x-lasso-access-token

Path parameters

identifierstring required

Partner identifier. Interpreted according to by.

Query parameters

by'slug' | 'id' | 'lasso_key' | 'name' | 'external'

How to read the partner identifier in the path. See Resource Lookup.

external_system_typestring

Required when by=external. e.g. HUBSPOT, SALESFORCE, PIPEDRIVE

external_object_typestring

Required when by=external (optional for a Salesforce partner). e.g. company, deal, opportunity, account

Request body

The system this record lives in. Sent in any case and stored upper-case.

object_typestring required

The kind of CRM object. Use custom_partner_object for a partner represented by a custom object. Must be one of Lasso's known object types; an unrecognised value is rejected rather than stored, since a typo would otherwise persist a link nothing reads.

identifier_valuestring

The CRM record's ID. Named identifier_value so it does not collide with the partner identifier in the path; external_identifier is accepted as an alias.

external_identifierstring

Alias for identifier_value

Example request

{
  "system_type": "HUBSPOT",
  "object_type": "custom_partner_object",
  "identifier_value": "22329802508"
}

Response

The partner already pointed at this record; nothing changed

Example response

{
  "external_id": {
    "system_type": "HUBSPOT",
    "object_type": "custom_partner_object",
    "identifier": "22329802508",
    "partner_slug": "acme-corp"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.