Summary

The Contacts b2b provides an interface for creating and managing an organizations contacts.


Get Contacts

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

Retrieves the contacts owned by the organization

Input

id:  the owner organization id

Response: 

A Paginated List of ContactVo objects

Get Primary Contact

 GET /v2/b2b/organization/{id}/contact/primary

Retrieves the primary contact of the organization

Input

id:  the owner organization id

Response: 

A ContactVo object if successful

 

Get Single Contact

 GET /v2/b2b/organization/{id}/contact/{contactId}

Retrieves a single contact of the organization

Input

id:  the owner organization id

contactId: the contact id

Response: 

A ContactVo object if successful


Get Contacts by Address

GET /v2/b2b/organization/{id}/address/{addressId}/contacts

Retrieves a list of contact using a specific address

Input

id:  the owner organization id

addressId: the requested address Id

Response: 

A list of ContactVo object


Create Contact

POST /v2/b2b/organization/{id}/contact

Creates a new contact for the specified organization


Input

id:  the owner organization id

Body:

A ContactVo object

Response: 

A ContactVo object if successful 

Update Contact

PUT /v2/b2b/organization/{id}/contact


Update an existing contact of the organization


Input

id:  the owner organization id

Body:

A ContactVo object

Response: 

A ContactVo object if successful 


Delete Single Contact

 DELETE /v2/b2b/organization/{id}/contact/{contactId}

Deletes a single contact of the organization

Input

id:  the owner organization id

contactId: The contact Id

Response: 

A ContactVo object if successful


Objects

ContactVo Object

Field
Description
idContact ID
organizationIdOrganization ID
firstNameFirst Name of the Contact
lastNameLast Name of the Contact
emailEmail of the Contact
phoneNumberPhone Number of the Contact
titleTitle of the Contact
streetAddress1Address Line 1 of the contact
streetAddress2Address Line 2 of the contact
cityAddress City of the contact
stateAddress State/Province of the contact
zipCodeAddress Zip/Postal Code of the contact
countryAddress Country of the contact
passwordPassword hash of the contact
createdAtContact creation date
updatedAtContact last update date
onBoardedAtContact onboarding date
confirmationTokenConfirmation Token of the contact
recoveryTokenRecovery Token of the contact
primaryType of Contact primary/secondary
profileImageProfile Image URL of the contact
addressIdAddress ID of the contact


ContactVo
{
    "id" : 888,
    "organizationId" : 888,
    "firstName" "Robert",
    "lastName" "Smith",
    "email" "bsmith@acmeticketing.com",
    "phoneNumber" "",
    "title" "",
    "streetAddress1" "1365 Woodland Terrace",
    "streetAddress2" "916-873-2532",
    "city" "Sacramento",
    "state" "CA",
    "zipCode" "95814",
    "country" "United States",
    "password" "",
    "createdAt" "",
    "updatedAt" "",
    "confirmedAt" "",
    "onBoardedAt" "",
    "confirmationToken" "",
    "recoveryToken" "",
    "primary" true,
    "profileImage" "",
    "addressId"""