Integrations

Get Or Create Crm List

Get, or create, a list IN THE CUSTOMER'S CRM, matched by name.

IDEMPOTENT: calling twice with the same name returns the existing list rather than making a second one, which is what makes it safe to call before every membership change. 200, not 201, because most calls return a list that already existed.

The app takes these three as query parameters on a POST; they are a body here, because a POST carrying its arguments in the query string is not a shape to put in a public contract.

post/integrations/crm/lists

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/integrations/crm/lists
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

namestring required

List name. Matched in the CRM; created when absent.

connection_idstring required
entity_type'contacts' | 'companies' | 'deals' | 'leads' nullable

Which object the list holds. Omit for contacts.

Response

Successful Response

dataCrmPayload required

One CRM record, or one provider response.

Open-shaped ON PURPOSE. These bodies carry whatever the provider returned, the field set differs between HubSpot, Salesforce, Pipedrive and SugarCRM, and it grows every time one of them ships something. Pinning it would drop whatever a provider reported that this contract had not caught up on - which on a CRM surface means silently hiding the customer's own data from them.

Changes

No recorded changes to this operation across all 2 revisions of this API.