Summary
The Contacts b2b provides an interface for creating and managing an organizations contacts.
Get Contacts
GET /v2/b2b/organization/{id}/contactRetrieves 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/primaryRetrieves 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}/contactsRetrieves 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}/contactCreates 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}/contactUpdate 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 |
|---|---|
| id | Contact ID |
| organizationId | 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 | Address Line 1 of the contact |
| streetAddress2 | Address Line 2 of the contact |
| city | Address City of the contact |
| state | Address State/Province of the contact |
| zipCode | Address Zip/Postal Code of the contact |
| country | Address Country of the contact |
| password | Password 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 | Address ID of the contact |
{ "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": ""} |