title: Accounts API 2.0 language_tabs:
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
GET /accounts/v2.0/accountcontact/{id}
Gets a specific account contact by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The account contact id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account the contact is associated with.",
"format": "int32"
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account contact.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account contact.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account contact.",
"maxLength": 100,
"nullable": true
},
"birthDate": {
"type": "string",
"description": "The birth date of the account contact.",
"format": "date-time",
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account contact.",
"maxLength": 75,
"nullable": true
},
"contactConsentExpirationDateTime": {
"type": "string",
"description": "The expiration of consent, used primarily in regions where consent is required to send email to the contact.",
"format": "date-time",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"description": "The source through which the contact consented to receive email, used primarily in regions where consent is required to send email to the contact.",
"maxLength": 100,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account contact.",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account contact.",
"maxLength": 150,
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "The email address for the account contact.",
"maxLength": 100,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account contact.",
"maxLength": 50,
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name for the account contact.",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean",
"description": "Specifies whether or not the account contact appears in Zywave applications not used to manage accounts and account contacts."
},
"isArchived": {
"type": "boolean",
"description": "Specifies whether an account has been deleted from view in Zywave applications including applications used to manage accounts and contacts."
},
"isEmailAllowed": {
"type": "boolean",
"description": "Specifies whether the account contact will receive email notifications related to distributions sent from zywave applications."
},
"isPrimaryContact": {
"type": "boolean",
"description": "Specifies whether or not the contact is a primary contact for the account. More than one primary contact can exist per account. Primary contacts will appear on the account information screen in applications used to manage accounts and contacts."
},
"lastName": {
"type": "string",
"description": "The last name for the account contact.",
"maxLength": 50,
"nullable": true
},
"mobilePhoneNumber": {
"type": "string",
"description": "The mobile phone number for the account contact.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for the account contact.",
"maxLength": 50,
"nullable": true
},
"phoneNumberExtension": {
"type": "string",
"description": "The phone number extension for the account contact.",
"maxLength": 10,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account contact.",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"description": "The proper salutation for the account contact.",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account contact.",
"maxLength": 4,
"nullable": true
},
"title": {
"type": "string",
"description": "The business title for the account contact.",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"description": "The line of businesses associated with the account contact.",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"description": "The list of addresses for the account contact.",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"description": "The list of phones for the account contact.",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the account contact.",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"description": "The date in which the account contact was created.",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"description": "The date in which the account contact was updated.",
"format": "date-time"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AccountContact |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /accounts/v2.0/accountcontact/{id}
Updates an account contact.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account the contact is associated with.",
"format": "int32"
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account contact.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account contact.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account contact.",
"maxLength": 100,
"nullable": true
},
"birthDate": {
"type": "string",
"description": "The birth date of the account contact.",
"format": "date-time",
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account contact.",
"maxLength": 75,
"nullable": true
},
"contactConsentExpirationDateTime": {
"type": "string",
"description": "The expiration of consent, used primarily in regions where consent is required to send email to the contact.",
"format": "date-time",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"description": "The source through which the contact consented to receive email, used primarily in regions where consent is required to send email to the contact.",
"maxLength": 100,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account contact.",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account contact.",
"maxLength": 150,
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "The email address for the account contact.",
"maxLength": 100,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account contact.",
"maxLength": 50,
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name for the account contact.",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean",
"description": "Specifies whether or not the account contact appears in Zywave applications not used to manage accounts and account contacts."
},
"isArchived": {
"type": "boolean",
"description": "Specifies whether an account has been deleted from view in Zywave applications including applications used to manage accounts and contacts."
},
"isEmailAllowed": {
"type": "boolean",
"description": "Specifies whether the account contact will receive email notifications related to distributions sent from zywave applications."
},
"isPrimaryContact": {
"type": "boolean",
"description": "Specifies whether or not the contact is a primary contact for the account. More than one primary contact can exist per account. Primary contacts will appear on the account information screen in applications used to manage accounts and contacts."
},
"lastName": {
"type": "string",
"description": "The last name for the account contact.",
"maxLength": 50,
"nullable": true
},
"mobilePhoneNumber": {
"type": "string",
"description": "The mobile phone number for the account contact.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for the account contact.",
"maxLength": 50,
"nullable": true
},
"phoneNumberExtension": {
"type": "string",
"description": "The phone number extension for the account contact.",
"maxLength": 10,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account contact.",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"description": "The proper salutation for the account contact.",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account contact.",
"maxLength": 4,
"nullable": true
},
"title": {
"type": "string",
"description": "The business title for the account contact.",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"description": "The line of businesses associated with the account contact.",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"description": "The list of addresses for the account contact.",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"description": "The list of phones for the account contact.",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The account contact id. |
| body | body | AccountContactInfo | true | An object representing the account contact information. All fields will be updated. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
DELETE /accounts/v2.0/accountcontact/{id}
Delete an account contact.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The account contact id. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
| 409 | Conflict | none | ProblemDetails |
GET /accounts/v2.0/accountcontact
Search for account contacts.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties that can be used when filtering and ordering the response.
The following OData filter operations are supported by the Zywave API; each is accompanied by an example request.
| Operation | Example Request | Returns |
|---|---|---|
| endswith | endswith(lastName,'tact') | Returns all account contacts where the last name ends with 'tact' |
| startswith | startswith(lastName,'Cont') | Returns all account contacts where the last name starts with 'Cont' |
| contains | contains(lastName,'tact') | Returns all account contacts where the name contains 'tact' |
| Equals | accountId eq 2726742 | Returns all account contacts for the Zywave account with this unique id |
| Not Equals | isActive ne false | Returns all account contacts that are active |
| In | lastName in ('Cont', 'act') | Returns all account contacts where the last name is 'Cont' or 'act' |
| Not | not startswith(lastName, 'Cont') | Returns all account contacts where the last name does not start with 'Cont' |
The Zywave API also supports the And operation which will allow for multiple search criteria to be applied to a single request. For example, the following filter will return all active account contacts for the given account;
accountId eq 726742 and isActive ne false
The orderby operation also supports multiple levels of ordering. For example, to order the results by accountId then lastName the following can be used;
accountId asc, lastName asc
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account the contact is associated with.",
"format": "int32"
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account contact.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account contact.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account contact.",
"maxLength": 100,
"nullable": true
},
"birthDate": {
"type": "string",
"description": "The birth date of the account contact.",
"format": "date-time",
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account contact.",
"maxLength": 75,
"nullable": true
},
"contactConsentExpirationDateTime": {
"type": "string",
"description": "The expiration of consent, used primarily in regions where consent is required to send email to the contact.",
"format": "date-time",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"description": "The source through which the contact consented to receive email, used primarily in regions where consent is required to send email to the contact.",
"maxLength": 100,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account contact.",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account contact.",
"maxLength": 150,
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "The email address for the account contact.",
"maxLength": 100,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account contact.",
"maxLength": 50,
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name for the account contact.",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean",
"description": "Specifies whether or not the account contact appears in Zywave applications not used to manage accounts and account contacts."
},
"isArchived": {
"type": "boolean",
"description": "Specifies whether an account has been deleted from view in Zywave applications including applications used to manage accounts and contacts."
},
"isEmailAllowed": {
"type": "boolean",
"description": "Specifies whether the account contact will receive email notifications related to distributions sent from zywave applications."
},
"isPrimaryContact": {
"type": "boolean",
"description": "Specifies whether or not the contact is a primary contact for the account. More than one primary contact can exist per account. Primary contacts will appear on the account information screen in applications used to manage accounts and contacts."
},
"lastName": {
"type": "string",
"description": "The last name for the account contact.",
"maxLength": 50,
"nullable": true
},
"mobilePhoneNumber": {
"type": "string",
"description": "The mobile phone number for the account contact.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for the account contact.",
"maxLength": 50,
"nullable": true
},
"phoneNumberExtension": {
"type": "string",
"description": "The phone number extension for the account contact.",
"maxLength": 10,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account contact.",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"description": "The proper salutation for the account contact.",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account contact.",
"maxLength": 4,
"nullable": true
},
"title": {
"type": "string",
"description": "The business title for the account contact.",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"description": "The line of businesses associated with the account contact.",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"description": "The list of addresses for the account contact.",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"description": "The list of phones for the account contact.",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the account contact.",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"description": "The date in which the account contact was created.",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"description": "The date in which the account contact was updated.",
"format": "date-time"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfAccountContact |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
POST /accounts/v2.0/accountcontact
Creates an account contact.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account the contact is associated with.",
"format": "int32"
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account contact.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account contact.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account contact.",
"maxLength": 100,
"nullable": true
},
"birthDate": {
"type": "string",
"description": "The birth date of the account contact.",
"format": "date-time",
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account contact.",
"maxLength": 75,
"nullable": true
},
"contactConsentExpirationDateTime": {
"type": "string",
"description": "The expiration of consent, used primarily in regions where consent is required to send email to the contact.",
"format": "date-time",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"description": "The source through which the contact consented to receive email, used primarily in regions where consent is required to send email to the contact.",
"maxLength": 100,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account contact.",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account contact.",
"maxLength": 150,
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "The email address for the account contact.",
"maxLength": 100,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account contact.",
"maxLength": 50,
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name for the account contact.",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean",
"description": "Specifies whether or not the account contact appears in Zywave applications not used to manage accounts and account contacts."
},
"isArchived": {
"type": "boolean",
"description": "Specifies whether an account has been deleted from view in Zywave applications including applications used to manage accounts and contacts."
},
"isEmailAllowed": {
"type": "boolean",
"description": "Specifies whether the account contact will receive email notifications related to distributions sent from zywave applications."
},
"isPrimaryContact": {
"type": "boolean",
"description": "Specifies whether or not the contact is a primary contact for the account. More than one primary contact can exist per account. Primary contacts will appear on the account information screen in applications used to manage accounts and contacts."
},
"lastName": {
"type": "string",
"description": "The last name for the account contact.",
"maxLength": 50,
"nullable": true
},
"mobilePhoneNumber": {
"type": "string",
"description": "The mobile phone number for the account contact.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for the account contact.",
"maxLength": 50,
"nullable": true
},
"phoneNumberExtension": {
"type": "string",
"description": "The phone number extension for the account contact.",
"maxLength": 10,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account contact.",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"description": "The proper salutation for the account contact.",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account contact.",
"maxLength": 4,
"nullable": true
},
"title": {
"type": "string",
"description": "The business title for the account contact.",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"description": "The line of businesses associated with the account contact.",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"description": "The list of addresses for the account contact.",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"description": "The list of phones for the account contact.",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | AccountContactInfo | true | An object representing the account contact information. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | none | integer |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /accounts/v2.0/account/{id}
Gets a specific business or personal account by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The account id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"isArchived": {
"type": "boolean",
"description": "Indicates whether the account is archived.",
"default": false
},
"name": {
"type": "string",
"description": "The name of the account.",
"maxLength": 255,
"minLength": 1
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account.",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account.",
"maxLength": 75,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account.",
"maxLength": 150,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account.",
"maxLength": 4,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account.",
"maxLength": 2,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for a business account.",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account.",
"maxLength": 50,
"nullable": true
},
"url": {
"type": "string",
"description": "The website for a business account.",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"description": "The number of employees for a business account.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "The number of retirees for a business account.",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "The year in which a business account was founded.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "The standard industry classification code for a business account. This code is used to classify the industry area of a business.",
"maxLength": 4,
"nullable": true
},
"naicsCodes": {
"type": "array",
"description": "A list of North American Classification Systems codes applicable to a business account. This code is used to classify a business for the purposes of collecting, analyzing and publishing data related to the US business economy. The code must be a 2- to 6-digit code. If a NAICS code isn't applicable to the most recent set of codes, you may optionally indicate the year it was applicable followed by a \"|\" before the standard 2- to 6-digit code. For example, 2012|212234 can be sent to represent the industry \"Copper Ore and Nickel Ore Mining\", although this code is not applicable to the 2017 set. The year must be a valid NAICS versioning year (e.g. 1997, or 2002, or 2007, etc.). For a list of all standardized NAICS codes, see https://www.census.gov/eos/www/naics/.",
"nullable": true,
"items": {
"type": "string"
}
},
"classification": {
"description": "Specifies whether the account is a business account or personal account.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"description": "A list of relationships a broker has with a client distinguishing whether the account is a current client or prospect for both the employee benefits and property and casualty units within the broker.",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"description": "Specifies a client size range for business accounts.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"description": "Determines whether the account is active throughout the Zywave product suite. If this is set to false the contacts for the account will also be marked as inactive and the account will not appear throughout the Zywave product suite. If not sent in the request isActive will be set to true.",
"default": true
},
"industryId": {
"type": "integer",
"description": "The unique Zywave identifier for the industry associated with the account.",
"format": "int32",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the account.",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"description": "The date in which the account was created.",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"description": "The date in which the account was last updated.",
"format": "date-time"
},
"msid": {
"type": "string",
"description": "The MiEdge MSID for this account.",
"nullable": true
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Account |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /accounts/v2.0/account/{id}
Updates a business or personal account.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"isArchived": {
"type": "boolean",
"description": "Indicates whether the account is archived.",
"default": false
},
"name": {
"type": "string",
"description": "The name of the account.",
"maxLength": 255,
"minLength": 1
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account.",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account.",
"maxLength": 75,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account.",
"maxLength": 150,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account.",
"maxLength": 4,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account.",
"maxLength": 2,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for a business account.",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account.",
"maxLength": 50,
"nullable": true
},
"url": {
"type": "string",
"description": "The website for a business account.",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"description": "The number of employees for a business account.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "The number of retirees for a business account.",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "The year in which a business account was founded.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "The standard industry classification code for a business account. This code is used to classify the industry area of a business.",
"maxLength": 4,
"nullable": true
},
"naicsCodes": {
"type": "array",
"description": "A list of North American Classification Systems codes applicable to a business account. This code is used to classify a business for the purposes of collecting, analyzing and publishing data related to the US business economy. The code must be a 2- to 6-digit code. If a NAICS code isn't applicable to the most recent set of codes, you may optionally indicate the year it was applicable followed by a \"|\" before the standard 2- to 6-digit code. For example, 2012|212234 can be sent to represent the industry \"Copper Ore and Nickel Ore Mining\", although this code is not applicable to the 2017 set. The year must be a valid NAICS versioning year (e.g. 1997, or 2002, or 2007, etc.). For a list of all standardized NAICS codes, see https://www.census.gov/eos/www/naics/.",
"nullable": true,
"items": {
"type": "string"
}
},
"classification": {
"description": "Specifies whether the account is a business account or personal account.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"description": "A list of relationships a broker has with a client distinguishing whether the account is a current client or prospect for both the employee benefits and property and casualty units within the broker.",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"description": "Specifies a client size range for business accounts.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"description": "Determines whether the account is active throughout the Zywave product suite. If this is set to false the contacts for the account will also be marked as inactive and the account will not appear throughout the Zywave product suite. If not sent in the request isActive will be set to true.",
"default": true
},
"industryId": {
"type": "integer",
"description": "The unique Zywave identifier for the industry associated with the account.",
"format": "int32",
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The account id. |
| body | body | AccountInfo | true | An object representing the account information. All fields will be updated. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
DELETE /accounts/v2.0/account/{id}
Delete a business or personal account.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The account id. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
| 409 | Conflict | none | ProblemDetails |
GET /accounts/v2.0/account/matches
Finds existing accounts using specified criteria and our standard matching algorithm
The Zywave API duplicate search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response. At least one criteria marked with double asterisks is required
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| includeArchived | query | boolean | false | Include archived accounts when finding matches |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"isArchived": {
"type": "boolean",
"description": "Indicates whether the account is archived.",
"default": false
},
"name": {
"type": "string",
"description": "The name of the account.",
"maxLength": 255,
"minLength": 1
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account.",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account.",
"maxLength": 75,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account.",
"maxLength": 150,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account.",
"maxLength": 4,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account.",
"maxLength": 2,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for a business account.",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account.",
"maxLength": 50,
"nullable": true
},
"url": {
"type": "string",
"description": "The website for a business account.",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"description": "The number of employees for a business account.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "The number of retirees for a business account.",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "The year in which a business account was founded.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "The standard industry classification code for a business account. This code is used to classify the industry area of a business.",
"maxLength": 4,
"nullable": true
},
"naicsCodes": {
"type": "array",
"description": "A list of North American Classification Systems codes applicable to a business account. This code is used to classify a business for the purposes of collecting, analyzing and publishing data related to the US business economy. The code must be a 2- to 6-digit code. If a NAICS code isn't applicable to the most recent set of codes, you may optionally indicate the year it was applicable followed by a \"|\" before the standard 2- to 6-digit code. For example, 2012|212234 can be sent to represent the industry \"Copper Ore and Nickel Ore Mining\", although this code is not applicable to the 2017 set. The year must be a valid NAICS versioning year (e.g. 1997, or 2002, or 2007, etc.). For a list of all standardized NAICS codes, see https://www.census.gov/eos/www/naics/.",
"nullable": true,
"items": {
"type": "string"
}
},
"classification": {
"description": "Specifies whether the account is a business account or personal account.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"description": "A list of relationships a broker has with a client distinguishing whether the account is a current client or prospect for both the employee benefits and property and casualty units within the broker.",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"description": "Specifies a client size range for business accounts.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"description": "Determines whether the account is active throughout the Zywave product suite. If this is set to false the contacts for the account will also be marked as inactive and the account will not appear throughout the Zywave product suite. If not sent in the request isActive will be set to true.",
"default": true
},
"industryId": {
"type": "integer",
"description": "The unique Zywave identifier for the industry associated with the account.",
"format": "int32",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the account.",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"description": "The date in which the account was created.",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"description": "The date in which the account was last updated.",
"format": "date-time"
},
"msid": {
"type": "string",
"description": "The MiEdge MSID for this account.",
"nullable": true
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfAccount |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /accounts/v2.0/account
Search for business and personal accounts.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is divisible by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"isArchived": {
"type": "boolean",
"description": "Indicates whether the account is archived.",
"default": false
},
"name": {
"type": "string",
"description": "The name of the account.",
"maxLength": 255,
"minLength": 1
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account.",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account.",
"maxLength": 75,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account.",
"maxLength": 150,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account.",
"maxLength": 4,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account.",
"maxLength": 2,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for a business account.",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account.",
"maxLength": 50,
"nullable": true
},
"url": {
"type": "string",
"description": "The website for a business account.",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"description": "The number of employees for a business account.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "The number of retirees for a business account.",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "The year in which a business account was founded.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "The standard industry classification code for a business account. This code is used to classify the industry area of a business.",
"maxLength": 4,
"nullable": true
},
"naicsCodes": {
"type": "array",
"description": "A list of North American Classification Systems codes applicable to a business account. This code is used to classify a business for the purposes of collecting, analyzing and publishing data related to the US business economy. The code must be a 2- to 6-digit code. If a NAICS code isn't applicable to the most recent set of codes, you may optionally indicate the year it was applicable followed by a \"|\" before the standard 2- to 6-digit code. For example, 2012|212234 can be sent to represent the industry \"Copper Ore and Nickel Ore Mining\", although this code is not applicable to the 2017 set. The year must be a valid NAICS versioning year (e.g. 1997, or 2002, or 2007, etc.). For a list of all standardized NAICS codes, see https://www.census.gov/eos/www/naics/.",
"nullable": true,
"items": {
"type": "string"
}
},
"classification": {
"description": "Specifies whether the account is a business account or personal account.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"description": "A list of relationships a broker has with a client distinguishing whether the account is a current client or prospect for both the employee benefits and property and casualty units within the broker.",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"description": "Specifies a client size range for business accounts.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"description": "Determines whether the account is active throughout the Zywave product suite. If this is set to false the contacts for the account will also be marked as inactive and the account will not appear throughout the Zywave product suite. If not sent in the request isActive will be set to true.",
"default": true
},
"industryId": {
"type": "integer",
"description": "The unique Zywave identifier for the industry associated with the account.",
"format": "int32",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the account.",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"description": "The date in which the account was created.",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"description": "The date in which the account was last updated.",
"format": "date-time"
},
"msid": {
"type": "string",
"description": "The MiEdge MSID for this account.",
"nullable": true
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfAccount |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
POST /accounts/v2.0/account
Creates a business or personal account.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"isArchived": {
"type": "boolean",
"description": "Indicates whether the account is archived.",
"default": false
},
"name": {
"type": "string",
"description": "The name of the account.",
"maxLength": 255,
"minLength": 1
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account.",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account.",
"maxLength": 75,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account.",
"maxLength": 150,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account.",
"maxLength": 4,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account.",
"maxLength": 2,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for a business account.",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account.",
"maxLength": 50,
"nullable": true
},
"url": {
"type": "string",
"description": "The website for a business account.",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"description": "The number of employees for a business account.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "The number of retirees for a business account.",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "The year in which a business account was founded.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "The standard industry classification code for a business account. This code is used to classify the industry area of a business.",
"maxLength": 4,
"nullable": true
},
"naicsCodes": {
"type": "array",
"description": "A list of North American Classification Systems codes applicable to a business account. This code is used to classify a business for the purposes of collecting, analyzing and publishing data related to the US business economy. The code must be a 2- to 6-digit code. If a NAICS code isn't applicable to the most recent set of codes, you may optionally indicate the year it was applicable followed by a \"|\" before the standard 2- to 6-digit code. For example, 2012|212234 can be sent to represent the industry \"Copper Ore and Nickel Ore Mining\", although this code is not applicable to the 2017 set. The year must be a valid NAICS versioning year (e.g. 1997, or 2002, or 2007, etc.). For a list of all standardized NAICS codes, see https://www.census.gov/eos/www/naics/.",
"nullable": true,
"items": {
"type": "string"
}
},
"classification": {
"description": "Specifies whether the account is a business account or personal account.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"description": "A list of relationships a broker has with a client distinguishing whether the account is a current client or prospect for both the employee benefits and property and casualty units within the broker.",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"description": "Specifies a client size range for business accounts.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"description": "Determines whether the account is active throughout the Zywave product suite. If this is set to false the contacts for the account will also be marked as inactive and the account will not appear throughout the Zywave product suite. If not sent in the request isActive will be set to true.",
"default": true
},
"industryId": {
"type": "integer",
"description": "The unique Zywave identifier for the industry associated with the account.",
"format": "int32",
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | AccountInfo | true | An object representing the account information. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | none | integer |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /accounts/v2.0/accountexternalreference
Search for external account reference.
An external reference is a relationship that links a Zywave account to an external account stored outside of Zywave. External references are often used to link a Zywave account to another system's account for integration purposes.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"description": "An external reference is a relationship that links a Zywave account to an external account stored outside of Zywave. External references are often used to link a Zywave account to another system's account for integration purposes.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the external reference.",
"format": "int32"
},
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account.",
"format": "int32"
},
"externalId": {
"type": "string",
"description": "The unique account identifier of the external system.",
"nullable": true
},
"sourceName": {
"type": "string",
"description": "The name of the external system the external identifier is associated with.",
"nullable": true
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfAccountExternalReference |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /accounts/v2.0/industry
Search for business and personal industries.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
The following OData filter operations are supported by the Zywave API; each is accompanied by an example request.
| Operation | Example Request | Returns |
|---|---|---|
| startswith | startswith(Name,'Zyw') | Returns all industries where the name starts with 'Zyw' |
| endswith | endswith(Name,'wave') | Returns all industries where the name ends with 'wave' |
| contains | contains(Name,'wave') | Returns all industries where the name contains 'wave' |
| Equals | Name eq 'Zywave' | Returns all industries named Zywave |
| Not Equals | Name ne 'Zywave' | Returns all industries not named Zywave |
| Greater Than | naicsCode gt 22 | Returns all industries with a nacisCode greater than 22 |
| Greater Than or equal | naicsCode ge 22 | Returns all industries with a nacisCode greater than or equal to 22 |
| Less Than | naicsCode lt 22 | Returns all industries with a nacisCode less than or equal to 22 |
| Less Than or equal | naicsCode le 22 | Returns all industries with a nacisCode less than or equal to 22 |
| In | Name in ('Zyw', 'ave') | Returns all industries with the names 'Zyw' or 'ave'. |
| Not | not startswith(Name,'Zyw') | Returns all industries with a name that doesn't start with ‘Zyw’ |
| The Zywave API also supports the And operation which will allow for multiple search criteria to be applied to a single request. For example, the following filter will return all industries with a name that incldes ‘I’ and a naicsCode greater than 22 |
Contains(Name, 'I') and naicsCode gt 22
The orderby operation also supports multiple levels of ordering. For example, to order the results by name and then by naicsCode, the following can be used;
Name asc, naicsCode desc
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | none |
| $orderBy | query | string | false | none |
| $skip | query | integer(int32) | false | none |
| $take | query | integer(int32) | false | none |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the industry.",
"format": "int32"
},
"name": {
"type": "string",
"description": "The display name for the industry.",
"nullable": true
},
"naicsCode": {
"type": "integer",
"description": "The two-digit NAICS code for the industry.",
"format": "int32",
"nullable": true
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfIndustry |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account the contact is associated with.",
"format": "int32"
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account contact.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account contact.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account contact.",
"maxLength": 100,
"nullable": true
},
"birthDate": {
"type": "string",
"description": "The birth date of the account contact.",
"format": "date-time",
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account contact.",
"maxLength": 75,
"nullable": true
},
"contactConsentExpirationDateTime": {
"type": "string",
"description": "The expiration of consent, used primarily in regions where consent is required to send email to the contact.",
"format": "date-time",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"description": "The source through which the contact consented to receive email, used primarily in regions where consent is required to send email to the contact.",
"maxLength": 100,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account contact.",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account contact.",
"maxLength": 150,
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "The email address for the account contact.",
"maxLength": 100,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account contact.",
"maxLength": 50,
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name for the account contact.",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean",
"description": "Specifies whether or not the account contact appears in Zywave applications not used to manage accounts and account contacts."
},
"isArchived": {
"type": "boolean",
"description": "Specifies whether an account has been deleted from view in Zywave applications including applications used to manage accounts and contacts."
},
"isEmailAllowed": {
"type": "boolean",
"description": "Specifies whether the account contact will receive email notifications related to distributions sent from zywave applications."
},
"isPrimaryContact": {
"type": "boolean",
"description": "Specifies whether or not the contact is a primary contact for the account. More than one primary contact can exist per account. Primary contacts will appear on the account information screen in applications used to manage accounts and contacts."
},
"lastName": {
"type": "string",
"description": "The last name for the account contact.",
"maxLength": 50,
"nullable": true
},
"mobilePhoneNumber": {
"type": "string",
"description": "The mobile phone number for the account contact.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for the account contact.",
"maxLength": 50,
"nullable": true
},
"phoneNumberExtension": {
"type": "string",
"description": "The phone number extension for the account contact.",
"maxLength": 10,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account contact.",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"description": "The proper salutation for the account contact.",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account contact.",
"maxLength": 4,
"nullable": true
},
"title": {
"type": "string",
"description": "The business title for the account contact.",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"description": "The line of businesses associated with the account contact.",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"description": "The list of addresses for the account contact.",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"description": "The list of phones for the account contact.",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the account contact.",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"description": "The date in which the account contact was created.",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"description": "The date in which the account contact was updated.",
"format": "date-time"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | AccountContactInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the account contact. |
| » createdDateTime | string(date-time) | false | none | The date in which the account contact was created. |
| » updatedDateTime | string(date-time) | false | none | The date in which the account contact was updated. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account the contact is associated with.",
"format": "int32"
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account contact.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account contact.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account contact.",
"maxLength": 100,
"nullable": true
},
"birthDate": {
"type": "string",
"description": "The birth date of the account contact.",
"format": "date-time",
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account contact.",
"maxLength": 75,
"nullable": true
},
"contactConsentExpirationDateTime": {
"type": "string",
"description": "The expiration of consent, used primarily in regions where consent is required to send email to the contact.",
"format": "date-time",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"description": "The source through which the contact consented to receive email, used primarily in regions where consent is required to send email to the contact.",
"maxLength": 100,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account contact.",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account contact.",
"maxLength": 150,
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "The email address for the account contact.",
"maxLength": 100,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account contact.",
"maxLength": 50,
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name for the account contact.",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean",
"description": "Specifies whether or not the account contact appears in Zywave applications not used to manage accounts and account contacts."
},
"isArchived": {
"type": "boolean",
"description": "Specifies whether an account has been deleted from view in Zywave applications including applications used to manage accounts and contacts."
},
"isEmailAllowed": {
"type": "boolean",
"description": "Specifies whether the account contact will receive email notifications related to distributions sent from zywave applications."
},
"isPrimaryContact": {
"type": "boolean",
"description": "Specifies whether or not the contact is a primary contact for the account. More than one primary contact can exist per account. Primary contacts will appear on the account information screen in applications used to manage accounts and contacts."
},
"lastName": {
"type": "string",
"description": "The last name for the account contact.",
"maxLength": 50,
"nullable": true
},
"mobilePhoneNumber": {
"type": "string",
"description": "The mobile phone number for the account contact.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for the account contact.",
"maxLength": 50,
"nullable": true
},
"phoneNumberExtension": {
"type": "string",
"description": "The phone number extension for the account contact.",
"maxLength": 10,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account contact.",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"description": "The proper salutation for the account contact.",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account contact.",
"maxLength": 4,
"nullable": true
},
"title": {
"type": "string",
"description": "The business title for the account contact.",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"description": "The line of businesses associated with the account contact.",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"description": "The list of addresses for the account contact.",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"description": "The list of phones for the account contact.",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | integer(int32) | false | none | The unique Zywave identifier for the account the contact is associated with. |
| addressLine1 | string|null | false | none | Line 1 of the primary address for the account contact. |
| addressLine2 | string|null | false | none | Line 2 of the primary address for the account contact. |
| addressLine3 | string|null | false | none | Line 3 of the primary address for the account contact. |
| birthDate | string(date-time)|null | false | none | The birth date of the account contact. |
| city | string|null | false | none | The city of the primary address for the account contact. |
| contactConsentExpirationDateTime | string(date-time)|null | false | none | The expiration of consent, used primarily in regions where consent is required to send email to the contact. |
| contactConsentSource | string|null | false | none | The source through which the contact consented to receive email, used primarily in regions where consent is required to send email to the contact. |
| country | string|null | false | none | The country of the primary address for the account contact. |
| county | string|null | false | none | The county of the primary address for the account contact. |
| emailAddress | string|null | false | none | The email address for the account contact. |
| faxNumber | string|null | false | none | The fax number for the account contact. |
| firstName | string|null | false | none | The first name for the account contact. |
| isActive | boolean | false | none | Specifies whether or not the account contact appears in Zywave applications not used to manage accounts and account contacts. |
| isArchived | boolean | false | none | Specifies whether an account has been deleted from view in Zywave applications including applications used to manage accounts and contacts. |
| isEmailAllowed | boolean | false | none | Specifies whether the account contact will receive email notifications related to distributions sent from zywave applications. |
| isPrimaryContact | boolean | false | none | Specifies whether or not the contact is a primary contact for the account. More than one primary contact can exist per account. Primary contacts will appear on the account information screen in applications used to manage accounts and contacts. |
| lastName | string|null | false | none | The last name for the account contact. |
| mobilePhoneNumber | string|null | false | none | The mobile phone number for the account contact. |
| phoneNumber | string|null | false | none | The phone number for the account contact. |
| phoneNumberExtension | string|null | false | none | The phone number extension for the account contact. |
| postalCode | string|null | false | none | The zip code or postal code of the primary address for the account contact. |
| salutation | string|null | false | none | The proper salutation for the account contact. |
| state | string|null | false | none | The state of the primary address for the account contact. |
| title | string|null | false | none | The business title for the account contact. |
| linesOfBusiness | [LineOfBusiness]|null | false | none | The line of businesses associated with the account contact. |
| addresses | [Address]|null | false | none | The list of addresses for the account contact. |
| phones | [Phone]|null | false | none | The list of phones for the account contact. |
{
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Benefits |
| anonymous | PC |
| anonymous | PersonalLines |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | AddressInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountContactId | integer(int32) | false | none | none |
| addressLine1 | string|null | false | none | none |
| addressLine2 | string|null | false | none | none |
| addressLine3 | string|null | false | none | none |
| city | string|null | false | none | none |
| country | string|null | false | none | none |
| county | string|null | false | none | none |
| isPrimary | boolean | false | none | none |
| postalCode | string|null | false | none | none |
| state | string|null | false | none | none |
| type | AddressType | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Home |
| anonymous | Mailing |
| anonymous | Office |
| anonymous | Billing |
| anonymous | Business |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | PhoneInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountContactId | integer(int32) | false | none | none |
| extension | string|null | false | none | none |
| isPrimary | boolean | false | none | none |
| number | string|null | false | none | none |
| type | PhoneType | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Mobile |
| anonymous | Work |
| anonymous | Home |
| anonymous | Fax |
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| additionalProperties | any | false | none | none |
| type | string|null | false | none | none |
| title | string|null | false | none | none |
| status | integer(int32)|null | false | none | none |
| detail | string|null | false | none | none |
| instance | string|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account the contact is associated with.",
"format": "int32"
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account contact.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account contact.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account contact.",
"maxLength": 100,
"nullable": true
},
"birthDate": {
"type": "string",
"description": "The birth date of the account contact.",
"format": "date-time",
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account contact.",
"maxLength": 75,
"nullable": true
},
"contactConsentExpirationDateTime": {
"type": "string",
"description": "The expiration of consent, used primarily in regions where consent is required to send email to the contact.",
"format": "date-time",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"description": "The source through which the contact consented to receive email, used primarily in regions where consent is required to send email to the contact.",
"maxLength": 100,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account contact.",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account contact.",
"maxLength": 150,
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "The email address for the account contact.",
"maxLength": 100,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account contact.",
"maxLength": 50,
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name for the account contact.",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean",
"description": "Specifies whether or not the account contact appears in Zywave applications not used to manage accounts and account contacts."
},
"isArchived": {
"type": "boolean",
"description": "Specifies whether an account has been deleted from view in Zywave applications including applications used to manage accounts and contacts."
},
"isEmailAllowed": {
"type": "boolean",
"description": "Specifies whether the account contact will receive email notifications related to distributions sent from zywave applications."
},
"isPrimaryContact": {
"type": "boolean",
"description": "Specifies whether or not the contact is a primary contact for the account. More than one primary contact can exist per account. Primary contacts will appear on the account information screen in applications used to manage accounts and contacts."
},
"lastName": {
"type": "string",
"description": "The last name for the account contact.",
"maxLength": 50,
"nullable": true
},
"mobilePhoneNumber": {
"type": "string",
"description": "The mobile phone number for the account contact.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for the account contact.",
"maxLength": 50,
"nullable": true
},
"phoneNumberExtension": {
"type": "string",
"description": "The phone number extension for the account contact.",
"maxLength": 10,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account contact.",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"description": "The proper salutation for the account contact.",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account contact.",
"maxLength": 4,
"nullable": true
},
"title": {
"type": "string",
"description": "The business title for the account contact.",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"description": "The line of businesses associated with the account contact.",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"description": "The list of addresses for the account contact.",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"description": "The list of phones for the account contact.",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the account contact.",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"description": "The date in which the account contact was created.",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"description": "The date in which the account contact was updated.",
"format": "date-time"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [AccountContact] | false | none | none |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | HttpValidationProblemDetails | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » additionalProperties | any | false | none | none |
| » errors | object | false | none | none |
| »» additionalProperties | [string] | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ProblemDetails | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » additionalProperties | any | false | none | none |
| » errors | object | false | none | none |
| »» additionalProperties | [string] | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"isArchived": {
"type": "boolean",
"description": "Indicates whether the account is archived.",
"default": false
},
"name": {
"type": "string",
"description": "The name of the account.",
"maxLength": 255,
"minLength": 1
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account.",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account.",
"maxLength": 75,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account.",
"maxLength": 150,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account.",
"maxLength": 4,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account.",
"maxLength": 2,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for a business account.",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account.",
"maxLength": 50,
"nullable": true
},
"url": {
"type": "string",
"description": "The website for a business account.",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"description": "The number of employees for a business account.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "The number of retirees for a business account.",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "The year in which a business account was founded.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "The standard industry classification code for a business account. This code is used to classify the industry area of a business.",
"maxLength": 4,
"nullable": true
},
"naicsCodes": {
"type": "array",
"description": "A list of North American Classification Systems codes applicable to a business account. This code is used to classify a business for the purposes of collecting, analyzing and publishing data related to the US business economy. The code must be a 2- to 6-digit code. If a NAICS code isn't applicable to the most recent set of codes, you may optionally indicate the year it was applicable followed by a \"|\" before the standard 2- to 6-digit code. For example, 2012|212234 can be sent to represent the industry \"Copper Ore and Nickel Ore Mining\", although this code is not applicable to the 2017 set. The year must be a valid NAICS versioning year (e.g. 1997, or 2002, or 2007, etc.). For a list of all standardized NAICS codes, see https://www.census.gov/eos/www/naics/.",
"nullable": true,
"items": {
"type": "string"
}
},
"classification": {
"description": "Specifies whether the account is a business account or personal account.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"description": "A list of relationships a broker has with a client distinguishing whether the account is a current client or prospect for both the employee benefits and property and casualty units within the broker.",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"description": "Specifies a client size range for business accounts.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"description": "Determines whether the account is active throughout the Zywave product suite. If this is set to false the contacts for the account will also be marked as inactive and the account will not appear throughout the Zywave product suite. If not sent in the request isActive will be set to true.",
"default": true
},
"industryId": {
"type": "integer",
"description": "The unique Zywave identifier for the industry associated with the account.",
"format": "int32",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the account.",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"description": "The date in which the account was created.",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"description": "The date in which the account was last updated.",
"format": "date-time"
},
"msid": {
"type": "string",
"description": "The MiEdge MSID for this account.",
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | AccountInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the account. |
| » createdDateTime | string(date-time) | false | none | The date in which the account was created. |
| » updatedDateTime | string(date-time) | false | none | The date in which the account was last updated. |
| » msid | string|null | false | none | The MiEdge MSID for this account. |
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"isArchived": {
"type": "boolean",
"description": "Indicates whether the account is archived.",
"default": false
},
"name": {
"type": "string",
"description": "The name of the account.",
"maxLength": 255,
"minLength": 1
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account.",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account.",
"maxLength": 75,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account.",
"maxLength": 150,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account.",
"maxLength": 4,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account.",
"maxLength": 2,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for a business account.",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account.",
"maxLength": 50,
"nullable": true
},
"url": {
"type": "string",
"description": "The website for a business account.",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"description": "The number of employees for a business account.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "The number of retirees for a business account.",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "The year in which a business account was founded.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "The standard industry classification code for a business account. This code is used to classify the industry area of a business.",
"maxLength": 4,
"nullable": true
},
"naicsCodes": {
"type": "array",
"description": "A list of North American Classification Systems codes applicable to a business account. This code is used to classify a business for the purposes of collecting, analyzing and publishing data related to the US business economy. The code must be a 2- to 6-digit code. If a NAICS code isn't applicable to the most recent set of codes, you may optionally indicate the year it was applicable followed by a \"|\" before the standard 2- to 6-digit code. For example, 2012|212234 can be sent to represent the industry \"Copper Ore and Nickel Ore Mining\", although this code is not applicable to the 2017 set. The year must be a valid NAICS versioning year (e.g. 1997, or 2002, or 2007, etc.). For a list of all standardized NAICS codes, see https://www.census.gov/eos/www/naics/.",
"nullable": true,
"items": {
"type": "string"
}
},
"classification": {
"description": "Specifies whether the account is a business account or personal account.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"description": "A list of relationships a broker has with a client distinguishing whether the account is a current client or prospect for both the employee benefits and property and casualty units within the broker.",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"description": "Specifies a client size range for business accounts.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"description": "Determines whether the account is active throughout the Zywave product suite. If this is set to false the contacts for the account will also be marked as inactive and the account will not appear throughout the Zywave product suite. If not sent in the request isActive will be set to true.",
"default": true
},
"industryId": {
"type": "integer",
"description": "The unique Zywave identifier for the industry associated with the account.",
"format": "int32",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isArchived | boolean | false | none | Indicates whether the account is archived. |
| name | string | true | none | The name of the account. |
| addressLine1 | string|null | false | none | Line 1 of the primary address for the account. |
| addressLine2 | string|null | false | none | Line 2 of the primary address for the account. |
| addressLine3 | string|null | false | none | Line 3 of the primary address for the account. |
| city | string|null | false | none | The city of the primary address for the account. |
| county | string|null | false | none | The county of the primary address for the account. |
| state | string|null | false | none | The state of the primary address for the account. |
| country | string|null | false | none | The country of the primary address for the account. |
| postalCode | string|null | false | none | The zip code or postal code of the primary address for the account. |
| phoneNumber | string|null | false | none | The phone number for a business account. |
| faxNumber | string|null | false | none | The fax number for the account. |
| url | string|null | false | none | The website for a business account. |
| numberOfEmployees | integer(int32)|null | false | none | The number of employees for a business account. |
| numberOfRetirees | integer(int32)|null | false | none | The number of retirees for a business account. |
| yearFounded | integer(int32)|null | false | none | The year in which a business account was founded. |
| sicCode | string|null | false | none | The standard industry classification code for a business account. This code is used to classify the industry area of a business. |
| naicsCodes | [string]|null | false | none | A list of North American Classification Systems codes applicable to a business account. This code is used to classify a business for the purposes of collecting, analyzing and publishing data related to the US business economy. The code must be a 2- to 6-digit code. If a NAICS code isn't applicable to the most recent set of codes, you may optionally indicate the year it was applicable followed by a " |
| classification | AccountClassification | false | none | Specifies whether the account is a business account or personal account. |
| relationships | [AccountRelationship]|null | false | none | A list of relationships a broker has with a client distinguishing whether the account is a current client or prospect for both the employee benefits and property and casualty units within the broker. |
| clientSize | ClientSize|null | false | none | Specifies a client size range for business accounts. |
| isActive | boolean | false | none | Determines whether the account is active throughout the Zywave product suite. If this is set to false the contacts for the account will also be marked as inactive and the account will not appear throughout the Zywave product suite. If not sent in the request isActive will be set to true. |
| industryId | integer(int32)|null | false | none | The unique Zywave identifier for the industry associated with the account. |
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Personal |
| anonymous | Commercial |
{
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | BenefitProspect |
| anonymous | BenefitClient |
| anonymous | PcProspect |
| anonymous | PcClient |
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | From0To25 |
| anonymous | From26To50 |
| anonymous | From51To99 |
| anonymous | From100To499 |
| anonymous | From500To999 |
| anonymous | From1000To2499 |
| anonymous | From2500To4999 |
| anonymous | MoreThan4999 |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"isArchived": {
"type": "boolean",
"description": "Indicates whether the account is archived.",
"default": false
},
"name": {
"type": "string",
"description": "The name of the account.",
"maxLength": 255,
"minLength": 1
},
"addressLine1": {
"type": "string",
"description": "Line 1 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"description": "Line 2 of the primary address for the account.",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Line 3 of the primary address for the account.",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"description": "The city of the primary address for the account.",
"maxLength": 75,
"nullable": true
},
"county": {
"type": "string",
"description": "The county of the primary address for the account.",
"maxLength": 150,
"nullable": true
},
"state": {
"type": "string",
"description": "The state of the primary address for the account.",
"maxLength": 4,
"nullable": true
},
"country": {
"type": "string",
"description": "The country of the primary address for the account.",
"maxLength": 2,
"nullable": true
},
"postalCode": {
"type": "string",
"description": "The zip code or postal code of the primary address for the account.",
"maxLength": 50,
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phone number for a business account.",
"maxLength": 50,
"nullable": true
},
"faxNumber": {
"type": "string",
"description": "The fax number for the account.",
"maxLength": 50,
"nullable": true
},
"url": {
"type": "string",
"description": "The website for a business account.",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"description": "The number of employees for a business account.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "The number of retirees for a business account.",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "The year in which a business account was founded.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "The standard industry classification code for a business account. This code is used to classify the industry area of a business.",
"maxLength": 4,
"nullable": true
},
"naicsCodes": {
"type": "array",
"description": "A list of North American Classification Systems codes applicable to a business account. This code is used to classify a business for the purposes of collecting, analyzing and publishing data related to the US business economy. The code must be a 2- to 6-digit code. If a NAICS code isn't applicable to the most recent set of codes, you may optionally indicate the year it was applicable followed by a \"|\" before the standard 2- to 6-digit code. For example, 2012|212234 can be sent to represent the industry \"Copper Ore and Nickel Ore Mining\", although this code is not applicable to the 2017 set. The year must be a valid NAICS versioning year (e.g. 1997, or 2002, or 2007, etc.). For a list of all standardized NAICS codes, see https://www.census.gov/eos/www/naics/.",
"nullable": true,
"items": {
"type": "string"
}
},
"classification": {
"description": "Specifies whether the account is a business account or personal account.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"description": "A list of relationships a broker has with a client distinguishing whether the account is a current client or prospect for both the employee benefits and property and casualty units within the broker.",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"description": "Specifies a client size range for business accounts.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"description": "Determines whether the account is active throughout the Zywave product suite. If this is set to false the contacts for the account will also be marked as inactive and the account will not appear throughout the Zywave product suite. If not sent in the request isActive will be set to true.",
"default": true
},
"industryId": {
"type": "integer",
"description": "The unique Zywave identifier for the industry associated with the account.",
"format": "int32",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the account.",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"description": "The date in which the account was created.",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"description": "The date in which the account was last updated.",
"format": "date-time"
},
"msid": {
"type": "string",
"description": "The MiEdge MSID for this account.",
"nullable": true
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [Account] | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"description": "An external reference is a relationship that links a Zywave account to an external account stored outside of Zywave. External references are often used to link a Zywave account to another system's account for integration purposes.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the external reference.",
"format": "int32"
},
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account.",
"format": "int32"
},
"externalId": {
"type": "string",
"description": "The unique account identifier of the external system.",
"nullable": true
},
"sourceName": {
"type": "string",
"description": "The name of the external system the external identifier is associated with.",
"nullable": true
}
}
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [AccountExternalReference] | false | none | [An external reference is a relationship that links a Zywave account to an external account stored outside of Zywave. External references are often used to link a Zywave account to another system's account for integration purposes.] |
{
"type": "object",
"description": "An external reference is a relationship that links a Zywave account to an external account stored outside of Zywave. External references are often used to link a Zywave account to another system's account for integration purposes.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the external reference.",
"format": "int32"
},
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account.",
"format": "int32"
},
"externalId": {
"type": "string",
"description": "The unique account identifier of the external system.",
"nullable": true
},
"sourceName": {
"type": "string",
"description": "The name of the external system the external identifier is associated with.",
"nullable": true
}
}
}
An external reference is a relationship that links a Zywave account to an external account stored outside of Zywave. External references are often used to link a Zywave account to another system's account for integration purposes.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | The unique Zywave identifier for the external reference. |
| accountId | integer(int32) | false | none | The unique Zywave identifier for the account. |
| externalId | string|null | false | none | The unique account identifier of the external system. |
| sourceName | string|null | false | none | The name of the external system the external identifier is associated with. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the industry.",
"format": "int32"
},
"name": {
"type": "string",
"description": "The display name for the industry.",
"nullable": true
},
"naicsCode": {
"type": "integer",
"description": "The two-digit NAICS code for the industry.",
"format": "int32",
"nullable": true
}
}
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [Industry] | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the industry.",
"format": "int32"
},
"name": {
"type": "string",
"description": "The display name for the industry.",
"nullable": true
},
"naicsCode": {
"type": "integer",
"description": "The two-digit NAICS code for the industry.",
"format": "int32",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | The unique Zywave identifier for the industry. |
| name | string|null | false | none | The display name for the industry. |
| naicsCode | integer(int32)|null | false | none | The two-digit NAICS code for the industry. |