Summary

The Organizations b2b provides an interface for creating and managing a organizations.


Get Organization with Contact data by ID

 GET /v2/b2b/organization/integration/{id}

Gets a single organization by ID


Input

id:  the organization id

Response: 

An OrganizationWithContactVo object if successful


Get Organization Attributes data by id

 GET /v2/b2b/organization/integration/{id}/attributes

Gets a single organization by Id

Input

id:  the organization id

Response: 

A list of attributes


Get Organization with Contact data by external import ID

GET /v2/b2b/organization/integration/external/{id}

Gets a single organization by Id

Input

id:  the organization id

Response: 

An OrganizationWithContactVo object if successful


Get Organizations

GET /v2/b2b/organization/integration/list

Gets a single organization by Id

Inputs

  • page: Optional. The page that you want returned, default is 1.
  • pageSize: Optional. The number of items you want returned in a  page.  Default is 100.
  • sortField: Optional. The filed that you want to sort by 
  • updatedAfter: Optional, ISO8601 date string, Only returns customers that were updated after the specified date.
  • ignoreMyUpdates: Optional, boolean, defaults to false. When set to true, ignores the customers that were last updated by the current user.

Response: 

A paginated list of  OrganizationWithContactVo object if successful


Bulk Create Organization

POST /v2/b2b/organization/integration/bulk

Creates multiple organizations

Body:

A List of OrganizationWithContactVo objects

Response: 

A List of BulkErrorVo


Objects

Example Organization With Contact  JSON

CreateOrganizationVo
[{
      "id": 893,
      "name""ACME Technologies Inc",
      "streetAddress1""123 Main",
      "streetAddress2""",
      "city""Palo Alto",
      "state""CA",
      "zipCode""10014",
      "country""United States",
      "createdAt""2015-06-25T09:53:19-07:00",
      "updatedAt""2015-08-19T09:05:49-07:00",
      "phoneNumber""4048730600",
      "companyUrl""www.acmeeticketing.com",
      "source""source",
      "externalId""12312",
      "integrationId""12312",
      "externalImportId""1231",
      "version": 0,
      "externalVersion": 0,
      "phoneNotes""notes",
      "contact": [{
         "id": 415,
         "organizationId": 893,
         "organizationId": 893,
         "firstName""Albert",
         "lastName""Einstein",
         "email""albert@acmeticketing.com",
         "phoneNumber""4048730600",
         "streetAddress1""123 Main",
         "streetAddress2""",
         "city""Palo Alto",
         "state""ca",
         "zipCode""10014",
         "country""United States",
         "primary"true,
         "addressId": 2889,
         "version": 0,
         "externalVersion": 0,
         "contactId""1234",
         "source""source",
         "externalId""1234",
         "externalImportId""1234",
         "externalContactRelationImpId":"123",
         "phoneNotes""notes"
      }],
      "attributes":[
        {
            "category":"category",
            "description""desc",
            "notes""notes",
            "date""2015-06-25T09:53:19-07:00"
        }
      ]
   }]

Example BulkErrorVo  JSON

BulkErrorVo
[
    {
        "organizationImportId""1231",
        "contactImportId""1231",
        "error""Error string"
    }
]