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 using an 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

Created 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

Updated 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
Note
idContact Id 
organizationIdOwner Organization Id 
firstNameFirst Name of the Contact 
lastNameLast Name of the Contact 
emailEmail of the Contact 
phoneNumberPhone Number of the Contact 
titleTitle of the Contact 
streetAddress1The street address of the contact. 
streetAddress2The second part of the street address for the contact. 
cityThe city that the contact is in. 
stateThe state that the contact is in. 
zipCodeZip code for the contact. 
countryCountry for the contact. 
passwordPassoword 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 
addressIdId of the address record used by the contact 
ContactVo
{
    "id" : 888,
    "organizationId" : 888,
    "firstName" "",
    "lastName" "",
    "email" "",
    "phoneNumber" "",
    "title" "",
    "streetAddress1" "",
    "streetAddress2" "",
    "city" "",
    "state" "",
    "zipCode" "",
    "country" "",
    "password" "",
    "createdAt" "",
    "updatedAt" "",
    "confirmedAt" "",
    "onBoardedAt" "",
    "confirmationToken" "",
    "recoveryToken" "",
    "primary" true,
    "profileImage" "",
    "addressId"""