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
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 |
|---|---|---|
| id | Contact Id | |
| organizationId | Owner Organization Id | |
| firstName | First Name of the Contact | |
| lastName | Last Name of the Contact | |
| Email of the Contact | ||
| phoneNumber | Phone Number of the Contact | |
| title | Title of the Contact | |
| streetAddress1 | The street address of the contact. | |
| streetAddress2 | The second part of the street address for the contact. | |
| city | The city that the contact is in. | |
| state | The state that the contact is in. | |
| zipCode | Zip code for the contact. | |
| country | Country for the contact. | |
| password | Passoword hash of the contact | |
| createdAt | Contact creation date | |
| updatedAt | Contact last update date | |
| onBoardedAt | Contact onboarding date | |
| confirmationToken | Confirmation Token of the contact | |
| recoveryToken | Recovery Token of the contact | |
| primary | Type of Contact primary/secondary | |
| profileImage | Profile Image URL of the contact | |
| addressId | Id of the address record used by the contact |
{ "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": ""} |