---

title: Content API language_tabs:

• shell: Shell
• http: HTTP
• javascript: JavaScript
• javascript--nodejs: Node.JS
• ruby: Ruby
• python: Python
• java: Java
• go: Go toc_footers: [] includes: [] search: false highlight_theme: darkula headingLevel: 2

---

Content API v2.0

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:

• https://api.zywave.com

Authentication

• oAuth2 authentication.

  • Flow: authorizationCode
  • Authorization URL = https://auth.zywave.com/connect/authorize
  • Token URL = https://auth.zywave.com/connect/token

Scope	Scope Description
api.content	Full access to all agency operations
api.content:read	Read-only access to agencies

Content

Content_GetContent

GET /content/v2.0/content/{id}

Returns the content item for the id sent in the request.

Parameters

Name	In	Type	Required	Description
id	path	integer(int32)	true	The ID of the content item

Example responses

200 Response

{
  "allOf": [
    {
      "type": "object",
      "description": "ContentInfo represents the editable properties of a piece of content.",
      "additionalProperties": false,
      "properties": {
        "title": {
          "type": "string",
          "description": "The title of the piece of content.",
          "nullable": true
        },
        "description": {
          "type": "string",
          "description": "The description of the piece of content.",
          "nullable": true
        },
        "clientDescription": {
          "type": "string",
          "description": "The description clients see for the piece of content.",
          "nullable": true
        },
        "isActive": {
          "type": "boolean",
          "description": "Whether the content is active"
        },
        "file": {
          "type": "string",
          "description": "The file that will be associated to the content.",
          "format": "binary",
          "nullable": true
        },
        "createdDateTime": {
          "type": "string",
          "description": "The date the content was created",
          "format": "date-time",
          "nullable": true
        },
        "updatedDateTime": {
          "type": "string",
          "description": "The date the file was last edited",
          "format": "date-time",
          "nullable": true
        },
        "metadata": {
          "type": "array",
          "description": "Additional dynamic information about the content.",
          "nullable": true,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "type": "string",
                "nullable": true
              },
              "value": {
                "type": "string",
                "nullable": true
              }
            }
          }
        }
      }
    },
    {
      "type": "object",
      "description": "A piece of content represents a container for files and metadata in the Zywave system. Can be maintained by an agency or Zywave.",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "The unique Zywave identifier for the content.",
          "format": "int32"
        },
        "fileId": {
          "type": "integer",
          "description": "The unique identifier for the lastest ContentFile for the content.",
          "format": "int32"
        },
        "fileName": {
          "type": "string",
          "description": "The name of the lastest ContentFile for the content.",
          "nullable": true
        },
        "thumbnailUrl": {
          "type": "string",
          "description": "Thumbnail image source for the content.",
          "nullable": true
        },
        "tagNames": {
          "type": "array",
          "description": "A list of tags that describes what the content is.",
          "nullable": true,
          "items": {
            "type": "string"
          }
        }
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The desired piece of content.	Content
404	Not Found	none	ProblemDetails

Content_PutContent

PUT /content/v2.0/content/{id}

Updates an existing content item.

Body parameter

type: object
properties:
  Title:
    type: string
    nullable: true
  Description:
    type: string
    nullable: true
  ClientDescription:
    type: string
    nullable: true
  IsActive:
    type: boolean
  File:
    type: string
    format: binary
    nullable: true
  CreatedDateTime:
    type: string
    format: date-time
    nullable: true
  UpdatedDateTime:
    type: string
    format: date-time
    nullable: true
  Metadata:
    type: array
    nullable: true
    items:
      type: object
      additionalProperties: false
      properties:
        key:
          type: string
          nullable: true
        value:
          type: string
          nullable: true

Parameters

Name	In	Type	Required	Description
id	path	integer(int32)	true	The ID of the content to update
body	body	object	false	none
» Title	body	string|null	false	none
» Description	body	string|null	false	none
» ClientDescription	body	string|null	false	none
» IsActive	body	boolean	false	none
» File	body	string(binary)|null	false	none
» CreatedDateTime	body	string(date-time)|null	false	none
» UpdatedDateTime	body	string(date-time)|null	false	none
» Metadata	body	[KeyValuePairOfStringAndString]|null	false	none
»» key	body	string|null	false	none
»» value	body	string|null	false	none

Example responses

400 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
    }
  }
}

Responses

Status	Meaning	Description	Schema
204	No Content	none	None
400	Bad Request	none	ProblemDetails
404	Not Found	none	ProblemDetails

Content_DeleteContent

DELETE /content/v2.0/content/{id}

Deletes the content item with the associated content ID.

Parameters

Name	In	Type	Required	Description
id	path	integer(int32)	true	The ID of the content to delete.

Example responses

400 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
    }
  }
}

Responses

Status	Meaning	Description	Schema
204	No Content	none	None
400	Bad Request	none	ProblemDetails
404	Not Found	none	ProblemDetails

Content_GetContent2

GET /content/v2.0/content

Searches content.

See Zywave API search documentation for details.

Parameters

Name	In	Type	Required	Description
query	query	string	false	The text that should be used for the full text search on a content item's title, description, and file body
includeImportedContent	query	boolean	false	A flag controlling whether or not to include Imported and shared content in the search results
includeZywaveContent	query	boolean	false	A flag controlling whether or not to include Zywave content in the search results
includeThirdPartyContent	query	boolean	false	A flag controlling whether or not to include third party content in the search results
$filter	query	string	false	The filter used to find the desired agency users
$orderBy	query	string	false	The properties used to order the search results
$skip	query	integer(int32)	false	The number of records in the result set to skip
$top	query	integer(int32)	false	The maximum number of records after the first skip records to take from the remaining result set

Example responses

200 Response

{
  "type": "object",
  "description": "A model containing a collection of Content pieces and metadata about their position in a larger result list.",
  "additionalProperties": false,
  "properties": {
    "hasMoreResults": {
      "type": "boolean",
      "description": "A value indicating whether the larger result set has more results."
    },
    "pageIndex": {
      "type": "integer",
      "description": "The index of the page reflected by the collection.",
      "format": "int32",
      "nullable": true
    },
    "pageSize": {
      "type": "integer",
      "description": "The size of the page relfected by the collection.",
      "format": "int32",
      "nullable": true
    },
    "skip": {
      "type": "integer",
      "description": "A value indicating how many of the previous values in the larger result set were omitted.",
      "format": "int32"
    },
    "take": {
      "type": "integer",
      "description": "The number of records retrieved from larger result set.",
      "format": "int32"
    },
    "totalCount": {
      "type": "integer",
      "description": "The total number of records in the larger result set.",
      "format": "int32"
    },
    "items": {
      "type": "array",
      "description": "The records retrieved from the larger result set.",
      "nullable": true,
      "items": {
        "allOf": [
          {
            "type": "object",
            "description": "ContentInfo represents the editable properties of a piece of content.",
            "additionalProperties": false,
            "properties": {
              "title": {
                "type": "string",
                "description": "The title of the piece of content.",
                "nullable": true
              },
              "description": {
                "type": "string",
                "description": "The description of the piece of content.",
                "nullable": true
              },
              "clientDescription": {
                "type": "string",
                "description": "The description clients see for the piece of content.",
                "nullable": true
              },
              "isActive": {
                "type": "boolean",
                "description": "Whether the content is active"
              },
              "file": {
                "type": "string",
                "description": "The file that will be associated to the content.",
                "format": "binary",
                "nullable": true
              },
              "createdDateTime": {
                "type": "string",
                "description": "The date the content was created",
                "format": "date-time",
                "nullable": true
              },
              "updatedDateTime": {
                "type": "string",
                "description": "The date the file was last edited",
                "format": "date-time",
                "nullable": true
              },
              "metadata": {
                "type": "array",
                "description": "Additional dynamic information about the content.",
                "nullable": true,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "key": {
                      "type": "string",
                      "nullable": true
                    },
                    "value": {
                      "type": "string",
                      "nullable": true
                    }
                  }
                }
              }
            }
          },
          {
            "type": "object",
            "description": "A piece of content represents a container for files and metadata in the Zywave system. Can be maintained by an agency or Zywave.",
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "integer",
                "description": "The unique Zywave identifier for the content.",
                "format": "int32"
              },
              "fileId": {
                "type": "integer",
                "description": "The unique identifier for the lastest ContentFile for the content.",
                "format": "int32"
              },
              "fileName": {
                "type": "string",
                "description": "The name of the lastest ContentFile for the content.",
                "nullable": true
              },
              "thumbnailUrl": {
                "type": "string",
                "description": "Thumbnail image source for the content.",
                "nullable": true
              },
              "tagNames": {
                "type": "array",
                "description": "A list of tags that describes what the content is.",
                "nullable": true,
                "items": {
                  "type": "string"
                }
              }
            }
          }
        ]
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	The desired piece of content.	PagedResultOfContent
400	Bad Request	none	string
403	Forbidden	none	ProblemDetails
404	Not Found	none	ProblemDetails

Content_PostContent

POST /content/v2.0/content

Creates a piece of content.

Body parameter

type: object
properties:
  Title:
    type: string
    nullable: true
  Description:
    type: string
    nullable: true
  ClientDescription:
    type: string
    nullable: true
  IsActive:
    type: boolean
  File:
    type: string
    format: binary
    nullable: true
  CreatedDateTime:
    type: string
    format: date-time
    nullable: true
  UpdatedDateTime:
    type: string
    format: date-time
    nullable: true
  Metadata:
    type: array
    nullable: true
    items:
      type: object
      additionalProperties: false
      properties:
        key:
          type: string
          nullable: true
        value:
          type: string
          nullable: true

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» Title	body	string|null	false	none
» Description	body	string|null	false	none
» ClientDescription	body	string|null	false	none
» IsActive	body	boolean	false	none
» File	body	string(binary)|null	false	none
» CreatedDateTime	body	string(date-time)|null	false	none
» UpdatedDateTime	body	string(date-time)|null	false	none
» Metadata	body	[KeyValuePairOfStringAndString]|null	false	none
»» key	body	string|null	false	none
»» value	body	string|null	false	none

Example responses

201 Response

{
  "type": "integer",
  "format": "int32"
}

Responses

Status	Meaning	Description	Schema
201	Created	The ID of the created content item.	integer
400	Bad Request	none	ProblemDetails

Download

Download_Download

POST /content/v2.0/download

Creates a file using the download request options and streams it back.

Body parameter

{
  "type": "object",
  "description": "The request that contains options for configuring the download of content",
  "additionalProperties": false,
  "properties": {
    "contentId": {
      "type": "integer",
      "description": "The unique Zywave identifier for the content.",
      "format": "int32"
    },
    "fileId": {
      "type": "integer",
      "description": "The unique Zywave identifier for the file under the content.",
      "format": "int32",
      "nullable": true
    },
    "convertToPDF": {
      "type": "boolean",
      "description": "The flag that will convert the file from its native format to a PDF, ignored for inapplicable filetypes"
    },
    "mergeFields": {
      "type": "object",
      "description": "The merge fields the download will attempt to find and replace in the body of the content, ignored for inapplicable filetypes",
      "nullable": true,
      "additionalProperties": {
        "type": "string"
      }
    },
    "brandId": {
      "type": "integer",
      "description": "The brand for merge fields to apply to the content when downloading, ignored for inapplicable filetypes",
      "format": "int32",
      "nullable": true
    },
    "themeId": {
      "type": "integer",
      "description": "The theme to apply to the content when downloading, ignored for inapplicable filetypes",
      "format": "int32",
      "nullable": true
    },
    "skipApplyingTheme": {
      "type": "boolean",
      "description": "Whether to skip applying the theme for this download, ignored for inapplicable filetypes"
    },
    "origin": {
      "type": "string",
      "description": "The origin of the request, used for logging and analytics",
      "nullable": true
    }
  }
}

Parameters

Name	In	Type	Required	Description
body	body	DownloadRequest	true	The request containg options for the download

Example responses

201 Response

400 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
    }
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	The ID of the created content item.	string
400	Bad Request	none	ProblemDetails
404	Not Found	none	ProblemDetails

Download_DownloadLink

POST /content/v2.0/download/link

Creates a file using the download request options and sends back a short lived link to download.

Body parameter

{
  "type": "object",
  "description": "The request that contains options for configuring the download of content",
  "additionalProperties": false,
  "properties": {
    "contentId": {
      "type": "integer",
      "description": "The unique Zywave identifier for the content.",
      "format": "int32"
    },
    "fileId": {
      "type": "integer",
      "description": "The unique Zywave identifier for the file under the content.",
      "format": "int32",
      "nullable": true
    },
    "convertToPDF": {
      "type": "boolean",
      "description": "The flag that will convert the file from its native format to a PDF, ignored for inapplicable filetypes"
    },
    "mergeFields": {
      "type": "object",
      "description": "The merge fields the download will attempt to find and replace in the body of the content, ignored for inapplicable filetypes",
      "nullable": true,
      "additionalProperties": {
        "type": "string"
      }
    },
    "brandId": {
      "type": "integer",
      "description": "The brand for merge fields to apply to the content when downloading, ignored for inapplicable filetypes",
      "format": "int32",
      "nullable": true
    },
    "themeId": {
      "type": "integer",
      "description": "The theme to apply to the content when downloading, ignored for inapplicable filetypes",
      "format": "int32",
      "nullable": true
    },
    "skipApplyingTheme": {
      "type": "boolean",
      "description": "Whether to skip applying the theme for this download, ignored for inapplicable filetypes"
    },
    "origin": {
      "type": "string",
      "description": "The origin of the request, used for logging and analytics",
      "nullable": true
    }
  }
}

Parameters

Name	In	Type	Required	Description
body	body	DownloadRequest	true	The request containg options for the download

Example responses

200 Response

{
  "type": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	The ID of the created content item.	string
400	Bad Request	none	ProblemDetails
404	Not Found	none	ProblemDetails

File

File_GetFile

GET /content/v2.0/file/{id}

Returns the file for the id sent in the request.

Parameters

Name	In	Type	Required	Description
id	path	integer(int32)	true	The ID of the file
contentId	query	integer(int32)	false	The ID of the content item

Example responses

200 Response

{
  "allOf": [
    {
      "type": "object",
      "description": "File represents the editable properties of a file.",
      "additionalProperties": false,
      "properties": {
        "contentId": {
          "type": "integer",
          "description": "The content identifier to add the file under.  Passing in null will create a new piece of content alongside the file",
          "format": "int32",
          "nullable": true
        },
        "fileId": {
          "type": "string",
          "description": "The unique file id that is associated to a file stored in the system. Generate a new guid if creating a new file.",
          "format": "guid"
        },
        "language": {
          "type": "string",
          "description": "The language code for the file. Defaults to US English \"en-us\". \nThere is no restrictions, but it is recommended that the value be set to the ISO 639-1 Language Code (https://www.andiamo.co.uk/resources/iso-language-codes/).",
          "nullable": true
        },
        "fileData": {
          "type": "string",
          "description": "The file data.",
          "format": "binary",
          "nullable": true
        }
      }
    },
    {
      "type": "object",
      "description": "An file lives underneath a piece of content and represents a single file or body of content.",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "The unique Zywave identifier for the file.",
          "format": "int32"
        }
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	The desired file.	File
404	Not Found	none	ProblemDetails

RecommendedContent

RecommendedContent_GetRecommendedContent

GET /content/v2.0/recommendedcontent

Searches recommended content

Parameters

Name	In	Type	Required	Description
naicsCode	query	integer(int32)	false	Filter recommended content by six-digit NAICS Code
clientSize	query	any	false	Filter recommended content by client/employer size
lineOfBusiness	query	any	false	Filter recommended content by line of business
usLocation	query	any	false	Fiter smart content by a location in the United States
includeZywaveRecommended	query	boolean	false	Include recommended content from Zywave experts.

Example responses

200 Response

{
  "type": "array",
  "items": {
    "type": "object",
    "description": "A group of content with various metadatas",
    "additionalProperties": false,
    "properties": {
      "name": {
        "type": "string",
        "description": "The name of the aggregation",
        "nullable": true
      },
      "category": {
        "type": "string",
        "description": "Category of the aggregation",
        "nullable": true
      },
      "value": {
        "type": "string",
        "description": "Aggregation value, refers to how the content was aggregated",
        "nullable": true
      },
      "sortOrder": {
        "type": "integer",
        "description": "Where the aggregation is sorted, 0 = first",
        "format": "int32"
      },
      "contentLookup": {
        "type": "array",
        "description": "A lookup of content ids and the smart content algorithm scores tied to those",
        "nullable": true,
        "items": {
          "type": "integer",
          "format": "int32"
        }
      },
      "content": {
        "type": "array",
        "description": "The list of content tied to this aggregation",
        "nullable": true,
        "items": {
          "allOf": [
            {
              "type": "object",
              "description": "ContentInfo represents the editable properties of a piece of content.",
              "additionalProperties": false,
              "properties": {
                "title": {
                  "type": "string",
                  "description": "The title of the piece of content.",
                  "nullable": true
                },
                "description": {
                  "type": "string",
                  "description": "The description of the piece of content.",
                  "nullable": true
                },
                "clientDescription": {
                  "type": "string",
                  "description": "The description clients see for the piece of content.",
                  "nullable": true
                },
                "isActive": {
                  "type": "boolean",
                  "description": "Whether the content is active"
                },
                "file": {
                  "type": "string",
                  "description": "The file that will be associated to the content.",
                  "format": "binary",
                  "nullable": true
                },
                "createdDateTime": {
                  "type": "string",
                  "description": "The date the content was created",
                  "format": "date-time",
                  "nullable": true
                },
                "updatedDateTime": {
                  "type": "string",
                  "description": "The date the file was last edited",
                  "format": "date-time",
                  "nullable": true
                },
                "metadata": {
                  "type": "array",
                  "description": "Additional dynamic information about the content.",
                  "nullable": true,
                  "items": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                      "key": {
                        "type": "string",
                        "nullable": true
                      },
                      "value": {
                        "type": "string",
                        "nullable": true
                      }
                    }
                  }
                }
              }
            },
            {
              "type": "object",
              "description": "A piece of content represents a container for files and metadata in the Zywave system. Can be maintained by an agency or Zywave.",
              "additionalProperties": false,
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "The unique Zywave identifier for the content.",
                  "format": "int32"
                },
                "fileId": {
                  "type": "integer",
                  "description": "The unique identifier for the lastest ContentFile for the content.",
                  "format": "int32"
                },
                "fileName": {
                  "type": "string",
                  "description": "The name of the lastest ContentFile for the content.",
                  "nullable": true
                },
                "thumbnailUrl": {
                  "type": "string",
                  "description": "Thumbnail image source for the content.",
                  "nullable": true
                },
                "tagNames": {
                  "type": "array",
                  "description": "A list of tags that describes what the content is.",
                  "nullable": true,
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          ]
        }
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of aggregated content.	Inline
400	Bad Request	none	string
403	Forbidden	none	ProblemDetails
404	Not Found	none	ProblemDetails

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ContentAggregation]	false	none	[A group of content with various metadatas]
» name	string|null	false	none	The name of the aggregation
» category	string|null	false	none	Category of the aggregation
» value	string|null	false	none	Aggregation value, refers to how the content was aggregated
» sortOrder	integer(int32)	false	none	Where the aggregation is sorted, 0 = first
» contentLookup	[integer]|null	false	none	A lookup of content ids and the smart content algorithm scores tied to those
» content	[allOf]|null	false	none	The list of content tied to this aggregation

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ContentInfo	false	none	ContentInfo represents the editable properties of a piece of content.
»»» title	string|null	false	none	The title of the piece of content.
»»» description	string|null	false	none	The description of the piece of content.
»»» clientDescription	string|null	false	none	The description clients see for the piece of content.
»»» isActive	boolean	false	none	Whether the content is active
»»» file	string(binary)|null	false	none	The file that will be associated to the content.
»»» createdDateTime	string(date-time)|null	false	none	The date the content was created
»»» updatedDateTime	string(date-time)|null	false	none	The date the file was last edited
»»» metadata	[KeyValuePairOfStringAndString]|null	false	none	Additional dynamic information about the content.
»»»» key	string|null	false	none	none
»»»» value	string|null	false	none	none

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	A piece of content represents a container for files and metadata in the Zywave system. Can be maintained by an agency or Zywave.
»»»» id	integer(int32)	false	none	The unique Zywave identifier for the content.
»»»» fileId	integer(int32)	false	none	The unique identifier for the lastest ContentFile for the content.
»»»» fileName	string|null	false	none	The name of the lastest ContentFile for the content.
»»»» thumbnailUrl	string|null	false	none	Thumbnail image source for the content.
»»»» tagNames	[string]|null	false	none	A list of tags that describes what the content is.

RecommendedContent_PostRecommendedContent

POST /content/v2.0/recommendedcontent

Post recommended content record

Body parameter

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "contentId": {
      "type": "integer",
      "format": "int32"
    },
    "bundleId": {
      "type": "integer",
      "format": "int32"
    },
    "startDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "endDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "naicsCodes": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "integer",
        "format": "int32"
      }
    },
    "clientSizeIds": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "integer",
        "format": "int32"
      }
    },
    "states": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "string"
      }
    }
  }
}

Parameters

Name	In	Type	Required	Description
body	body	RecommendedContentInfo	true	none

Example responses

201 Response

{
  "type": "integer",
  "format": "int32"
}

Responses

Status	Meaning	Description	Schema
201	Created	Returns the ID of the recommended content record posted	integer
400	Bad Request	none	ProblemDetails

RecommendedContent_PutRecommendedContent

PUT /content/v2.0/recommendedcontent/{id}

Update recommended content record

Body parameter

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "contentId": {
      "type": "integer",
      "format": "int32"
    },
    "bundleId": {
      "type": "integer",
      "format": "int32"
    },
    "startDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "endDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "naicsCodes": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "integer",
        "format": "int32"
      }
    },
    "clientSizeIds": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "integer",
        "format": "int32"
      }
    },
    "states": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "string"
      }
    }
  }
}

Parameters

Name	In	Type	Required	Description
id	path	integer(int32)	true	none
body	body	RecommendedContentInfo	true	none

Example responses

400 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
    }
  }
}

Responses

Status	Meaning	Description	Schema
204	No Content	none	None
400	Bad Request	none	ProblemDetails
404	Not Found	none	ProblemDetails

RecommendedContent_DeleteRecommendedContent

DELETE /content/v2.0/recommendedcontent/{id}

Deletes a recommended content record

Parameters

Name	In	Type	Required	Description
id	path	integer(int32)	true	none

Example responses

400 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
    }
  }
}

Responses

Status	Meaning	Description	Schema
204	No Content	none	None
400	Bad Request	none	ProblemDetails
404	Not Found	none	ProblemDetails

SmartContent

SmartContent_GetSmartContent

GET /content/v2.0/smartcontent

Searches company recommended content

Parameters

Name	In	Type	Required	Description
lineOfBusiness	query	LineOfBusiness	false	Filter smart content by line of business
naicsCode	query	integer(int32)	false	Filter smart content by six-digit NAICSCode
clientSize	query	any	false	Filter smartcontent by client/employer size
usLocation	query	any	false	Fiter smart content by a location in the United States
industryName	query	string	false	Filter smart content by industry name.

Enumerated Values

Parameter	Value
lineOfBusiness	1
lineOfBusiness	2
lineOfBusiness	3
lineOfBusiness	4
lineOfBusiness	5

Example responses

200 Response

{
  "type": "array",
  "items": {
    "type": "object",
    "description": "A group of content with various metadatas",
    "additionalProperties": false,
    "properties": {
      "name": {
        "type": "string",
        "description": "The name of the aggregation",
        "nullable": true
      },
      "category": {
        "type": "string",
        "description": "Category of the aggregation",
        "nullable": true
      },
      "value": {
        "type": "string",
        "description": "Aggregation value, refers to how the content was aggregated",
        "nullable": true
      },
      "sortOrder": {
        "type": "integer",
        "description": "Where the aggregation is sorted, 0 = first",
        "format": "int32"
      },
      "contentLookup": {
        "type": "array",
        "description": "A lookup of content ids and the smart content algorithm scores tied to those",
        "nullable": true,
        "items": {
          "type": "integer",
          "format": "int32"
        }
      },
      "content": {
        "type": "array",
        "description": "The list of content tied to this aggregation",
        "nullable": true,
        "items": {
          "allOf": [
            {
              "type": "object",
              "description": "ContentInfo represents the editable properties of a piece of content.",
              "additionalProperties": false,
              "properties": {
                "title": {
                  "type": "string",
                  "description": "The title of the piece of content.",
                  "nullable": true
                },
                "description": {
                  "type": "string",
                  "description": "The description of the piece of content.",
                  "nullable": true
                },
                "clientDescription": {
                  "type": "string",
                  "description": "The description clients see for the piece of content.",
                  "nullable": true
                },
                "isActive": {
                  "type": "boolean",
                  "description": "Whether the content is active"
                },
                "file": {
                  "type": "string",
                  "description": "The file that will be associated to the content.",
                  "format": "binary",
                  "nullable": true
                },
                "createdDateTime": {
                  "type": "string",
                  "description": "The date the content was created",
                  "format": "date-time",
                  "nullable": true
                },
                "updatedDateTime": {
                  "type": "string",
                  "description": "The date the file was last edited",
                  "format": "date-time",
                  "nullable": true
                },
                "metadata": {
                  "type": "array",
                  "description": "Additional dynamic information about the content.",
                  "nullable": true,
                  "items": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                      "key": {
                        "type": "string",
                        "nullable": true
                      },
                      "value": {
                        "type": "string",
                        "nullable": true
                      }
                    }
                  }
                }
              }
            },
            {
              "type": "object",
              "description": "A piece of content represents a container for files and metadata in the Zywave system. Can be maintained by an agency or Zywave.",
              "additionalProperties": false,
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "The unique Zywave identifier for the content.",
                  "format": "int32"
                },
                "fileId": {
                  "type": "integer",
                  "description": "The unique identifier for the lastest ContentFile for the content.",
                  "format": "int32"
                },
                "fileName": {
                  "type": "string",
                  "description": "The name of the lastest ContentFile for the content.",
                  "nullable": true
                },
                "thumbnailUrl": {
                  "type": "string",
                  "description": "Thumbnail image source for the content.",
                  "nullable": true
                },
                "tagNames": {
                  "type": "array",
                  "description": "A list of tags that describes what the content is.",
                  "nullable": true,
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          ]
        }
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of aggregated content.	Inline
400	Bad Request	none	string
403	Forbidden	none	ProblemDetails
404	Not Found	none	ProblemDetails

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ContentAggregation]	false	none	[A group of content with various metadatas]
» name	string|null	false	none	The name of the aggregation
» category	string|null	false	none	Category of the aggregation
» value	string|null	false	none	Aggregation value, refers to how the content was aggregated
» sortOrder	integer(int32)	false	none	Where the aggregation is sorted, 0 = first
» contentLookup	[integer]|null	false	none	A lookup of content ids and the smart content algorithm scores tied to those
» content	[allOf]|null	false	none	The list of content tied to this aggregation

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	ContentInfo	false	none	ContentInfo represents the editable properties of a piece of content.
»»» title	string|null	false	none	The title of the piece of content.
»»» description	string|null	false	none	The description of the piece of content.
»»» clientDescription	string|null	false	none	The description clients see for the piece of content.
»»» isActive	boolean	false	none	Whether the content is active
»»» file	string(binary)|null	false	none	The file that will be associated to the content.
»»» createdDateTime	string(date-time)|null	false	none	The date the content was created
»»» updatedDateTime	string(date-time)|null	false	none	The date the file was last edited
»»» metadata	[KeyValuePairOfStringAndString]|null	false	none	Additional dynamic information about the content.
»»»» key	string|null	false	none	none
»»»» value	string|null	false	none	none

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	A piece of content represents a container for files and metadata in the Zywave system. Can be maintained by an agency or Zywave.
»»»» id	integer(int32)	false	none	The unique Zywave identifier for the content.
»»»» fileId	integer(int32)	false	none	The unique identifier for the lastest ContentFile for the content.
»»»» fileName	string|null	false	none	The name of the lastest ContentFile for the content.
»»»» thumbnailUrl	string|null	false	none	Thumbnail image source for the content.
»»»» tagNames	[string]|null	false	none	A list of tags that describes what the content is.

Schemas

Content

{
  "allOf": [
    {
      "type": "object",
      "description": "ContentInfo represents the editable properties of a piece of content.",
      "additionalProperties": false,
      "properties": {
        "title": {
          "type": "string",
          "description": "The title of the piece of content.",
          "nullable": true
        },
        "description": {
          "type": "string",
          "description": "The description of the piece of content.",
          "nullable": true
        },
        "clientDescription": {
          "type": "string",
          "description": "The description clients see for the piece of content.",
          "nullable": true
        },
        "isActive": {
          "type": "boolean",
          "description": "Whether the content is active"
        },
        "file": {
          "type": "string",
          "description": "The file that will be associated to the content.",
          "format": "binary",
          "nullable": true
        },
        "createdDateTime": {
          "type": "string",
          "description": "The date the content was created",
          "format": "date-time",
          "nullable": true
        },
        "updatedDateTime": {
          "type": "string",
          "description": "The date the file was last edited",
          "format": "date-time",
          "nullable": true
        },
        "metadata": {
          "type": "array",
          "description": "Additional dynamic information about the content.",
          "nullable": true,
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "type": "string",
                "nullable": true
              },
              "value": {
                "type": "string",
                "nullable": true
              }
            }
          }
        }
      }
    },
    {
      "type": "object",
      "description": "A piece of content represents a container for files and metadata in the Zywave system. Can be maintained by an agency or Zywave.",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "The unique Zywave identifier for the content.",
          "format": "int32"
        },
        "fileId": {
          "type": "integer",
          "description": "The unique identifier for the lastest ContentFile for the content.",
          "format": "int32"
        },
        "fileName": {
          "type": "string",
          "description": "The name of the lastest ContentFile for the content.",
          "nullable": true
        },
        "thumbnailUrl": {
          "type": "string",
          "description": "Thumbnail image source for the content.",
          "nullable": true
        },
        "tagNames": {
          "type": "array",
          "description": "A list of tags that describes what the content is.",
          "nullable": true,
          "items": {
            "type": "string"
          }
        }
      }
    }
  ]
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ContentInfo	false	none	ContentInfo represents the editable properties of a piece of content.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	A piece of content represents a container for files and metadata in the Zywave system. Can be maintained by an agency or Zywave.
» id	integer(int32)	false	none	The unique Zywave identifier for the content.
» fileId	integer(int32)	false	none	The unique identifier for the lastest ContentFile for the content.
» fileName	string|null	false	none	The name of the lastest ContentFile for the content.
» thumbnailUrl	string|null	false	none	Thumbnail image source for the content.
» tagNames	[string]|null	false	none	A list of tags that describes what the content is.

ContentInfo

{
  "type": "object",
  "description": "ContentInfo represents the editable properties of a piece of content.",
  "additionalProperties": false,
  "properties": {
    "title": {
      "type": "string",
      "description": "The title of the piece of content.",
      "nullable": true
    },
    "description": {
      "type": "string",
      "description": "The description of the piece of content.",
      "nullable": true
    },
    "clientDescription": {
      "type": "string",
      "description": "The description clients see for the piece of content.",
      "nullable": true
    },
    "isActive": {
      "type": "boolean",
      "description": "Whether the content is active"
    },
    "file": {
      "type": "string",
      "description": "The file that will be associated to the content.",
      "format": "binary",
      "nullable": true
    },
    "createdDateTime": {
      "type": "string",
      "description": "The date the content was created",
      "format": "date-time",
      "nullable": true
    },
    "updatedDateTime": {
      "type": "string",
      "description": "The date the file was last edited",
      "format": "date-time",
      "nullable": true
    },
    "metadata": {
      "type": "array",
      "description": "Additional dynamic information about the content.",
      "nullable": true,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "key": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "type": "string",
            "nullable": true
          }
        }
      }
    }
  }
}

ContentInfo represents the editable properties of a piece of content.

Properties

Name	Type	Required	Restrictions	Description
title	string|null	false	none	The title of the piece of content.
description	string|null	false	none	The description of the piece of content.
clientDescription	string|null	false	none	The description clients see for the piece of content.
isActive	boolean	false	none	Whether the content is active
file	string(binary)|null	false	none	The file that will be associated to the content.
createdDateTime	string(date-time)|null	false	none	The date the content was created
updatedDateTime	string(date-time)|null	false	none	The date the file was last edited
metadata	[KeyValuePairOfStringAndString]|null	false	none	Additional dynamic information about the content.

KeyValuePairOfStringAndString

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "key": {
      "type": "string",
      "nullable": true
    },
    "value": {
      "type": "string",
      "nullable": true
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
key	string|null	false	none	none
value	string|null	false	none	none

ProblemDetails

{
  "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
    }
  }
}

Properties

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

PagedResultOfContent

{
  "type": "object",
  "description": "A model containing a collection of Content pieces and metadata about their position in a larger result list.",
  "additionalProperties": false,
  "properties": {
    "hasMoreResults": {
      "type": "boolean",
      "description": "A value indicating whether the larger result set has more results."
    },
    "pageIndex": {
      "type": "integer",
      "description": "The index of the page reflected by the collection.",
      "format": "int32",
      "nullable": true
    },
    "pageSize": {
      "type": "integer",
      "description": "The size of the page relfected by the collection.",
      "format": "int32",
      "nullable": true
    },
    "skip": {
      "type": "integer",
      "description": "A value indicating how many of the previous values in the larger result set were omitted.",
      "format": "int32"
    },
    "take": {
      "type": "integer",
      "description": "The number of records retrieved from larger result set.",
      "format": "int32"
    },
    "totalCount": {
      "type": "integer",
      "description": "The total number of records in the larger result set.",
      "format": "int32"
    },
    "items": {
      "type": "array",
      "description": "The records retrieved from the larger result set.",
      "nullable": true,
      "items": {
        "allOf": [
          {
            "type": "object",
            "description": "ContentInfo represents the editable properties of a piece of content.",
            "additionalProperties": false,
            "properties": {
              "title": {
                "type": "string",
                "description": "The title of the piece of content.",
                "nullable": true
              },
              "description": {
                "type": "string",
                "description": "The description of the piece of content.",
                "nullable": true
              },
              "clientDescription": {
                "type": "string",
                "description": "The description clients see for the piece of content.",
                "nullable": true
              },
              "isActive": {
                "type": "boolean",
                "description": "Whether the content is active"
              },
              "file": {
                "type": "string",
                "description": "The file that will be associated to the content.",
                "format": "binary",
                "nullable": true
              },
              "createdDateTime": {
                "type": "string",
                "description": "The date the content was created",
                "format": "date-time",
                "nullable": true
              },
              "updatedDateTime": {
                "type": "string",
                "description": "The date the file was last edited",
                "format": "date-time",
                "nullable": true
              },
              "metadata": {
                "type": "array",
                "description": "Additional dynamic information about the content.",
                "nullable": true,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "key": {
                      "type": "string",
                      "nullable": true
                    },
                    "value": {
                      "type": "string",
                      "nullable": true
                    }
                  }
                }
              }
            }
          },
          {
            "type": "object",
            "description": "A piece of content represents a container for files and metadata in the Zywave system. Can be maintained by an agency or Zywave.",
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "integer",
                "description": "The unique Zywave identifier for the content.",
                "format": "int32"
              },
              "fileId": {
                "type": "integer",
                "description": "The unique identifier for the lastest ContentFile for the content.",
                "format": "int32"
              },
              "fileName": {
                "type": "string",
                "description": "The name of the lastest ContentFile for the content.",
                "nullable": true
              },
              "thumbnailUrl": {
                "type": "string",
                "description": "Thumbnail image source for the content.",
                "nullable": true
              },
              "tagNames": {
                "type": "array",
                "description": "A list of tags that describes what the content is.",
                "nullable": true,
                "items": {
                  "type": "string"
                }
              }
            }
          }
        ]
      }
    }
  }
}

A model containing a collection of Content pieces and metadata about their position in a larger result list.

Properties

Name	Type	Required	Restrictions	Description
hasMoreResults	boolean	false	none	A value indicating whether the larger result set has more results.
pageIndex	integer(int32)|null	false	none	The index of the page reflected by the collection.
pageSize	integer(int32)|null	false	none	The size of the page relfected by the collection.
skip	integer(int32)	false	none	A value indicating how many of the previous values in the larger result set were omitted.
take	integer(int32)	false	none	The number of records retrieved from larger result set.
totalCount	integer(int32)	false	none	The total number of records in the larger result set.
items	[Content]|null	false	none	The records retrieved from the larger result set.

DownloadRequest

{
  "type": "object",
  "description": "The request that contains options for configuring the download of content",
  "additionalProperties": false,
  "properties": {
    "contentId": {
      "type": "integer",
      "description": "The unique Zywave identifier for the content.",
      "format": "int32"
    },
    "fileId": {
      "type": "integer",
      "description": "The unique Zywave identifier for the file under the content.",
      "format": "int32",
      "nullable": true
    },
    "convertToPDF": {
      "type": "boolean",
      "description": "The flag that will convert the file from its native format to a PDF, ignored for inapplicable filetypes"
    },
    "mergeFields": {
      "type": "object",
      "description": "The merge fields the download will attempt to find and replace in the body of the content, ignored for inapplicable filetypes",
      "nullable": true,
      "additionalProperties": {
        "type": "string"
      }
    },
    "brandId": {
      "type": "integer",
      "description": "The brand for merge fields to apply to the content when downloading, ignored for inapplicable filetypes",
      "format": "int32",
      "nullable": true
    },
    "themeId": {
      "type": "integer",
      "description": "The theme to apply to the content when downloading, ignored for inapplicable filetypes",
      "format": "int32",
      "nullable": true
    },
    "skipApplyingTheme": {
      "type": "boolean",
      "description": "Whether to skip applying the theme for this download, ignored for inapplicable filetypes"
    },
    "origin": {
      "type": "string",
      "description": "The origin of the request, used for logging and analytics",
      "nullable": true
    }
  }
}

The request that contains options for configuring the download of content

Properties

Name	Type	Required	Restrictions	Description
contentId	integer(int32)	false	none	The unique Zywave identifier for the content.
fileId	integer(int32)|null	false	none	The unique Zywave identifier for the file under the content.
convertToPDF	boolean	false	none	The flag that will convert the file from its native format to a PDF, ignored for inapplicable filetypes
mergeFields	object|null	false	none	The merge fields the download will attempt to find and replace in the body of the content, ignored for inapplicable filetypes
» additionalProperties	string	false	none	none
brandId	integer(int32)|null	false	none	The brand for merge fields to apply to the content when downloading, ignored for inapplicable filetypes
themeId	integer(int32)|null	false	none	The theme to apply to the content when downloading, ignored for inapplicable filetypes
skipApplyingTheme	boolean	false	none	Whether to skip applying the theme for this download, ignored for inapplicable filetypes
origin	string|null	false	none	The origin of the request, used for logging and analytics

File

{
  "allOf": [
    {
      "type": "object",
      "description": "File represents the editable properties of a file.",
      "additionalProperties": false,
      "properties": {
        "contentId": {
          "type": "integer",
          "description": "The content identifier to add the file under.  Passing in null will create a new piece of content alongside the file",
          "format": "int32",
          "nullable": true
        },
        "fileId": {
          "type": "string",
          "description": "The unique file id that is associated to a file stored in the system. Generate a new guid if creating a new file.",
          "format": "guid"
        },
        "language": {
          "type": "string",
          "description": "The language code for the file. Defaults to US English \"en-us\". \nThere is no restrictions, but it is recommended that the value be set to the ISO 639-1 Language Code (https://www.andiamo.co.uk/resources/iso-language-codes/).",
          "nullable": true
        },
        "fileData": {
          "type": "string",
          "description": "The file data.",
          "format": "binary",
          "nullable": true
        }
      }
    },
    {
      "type": "object",
      "description": "An file lives underneath a piece of content and represents a single file or body of content.",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "The unique Zywave identifier for the file.",
          "format": "int32"
        }
      }
    }
  ]
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	FileInfo	false	none	File represents the editable properties of a file.

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	An file lives underneath a piece of content and represents a single file or body of content.
» id	integer(int32)	false	none	The unique Zywave identifier for the file.

FileInfo

{
  "type": "object",
  "description": "File represents the editable properties of a file.",
  "additionalProperties": false,
  "properties": {
    "contentId": {
      "type": "integer",
      "description": "The content identifier to add the file under.  Passing in null will create a new piece of content alongside the file",
      "format": "int32",
      "nullable": true
    },
    "fileId": {
      "type": "string",
      "description": "The unique file id that is associated to a file stored in the system. Generate a new guid if creating a new file.",
      "format": "guid"
    },
    "language": {
      "type": "string",
      "description": "The language code for the file. Defaults to US English \"en-us\". \nThere is no restrictions, but it is recommended that the value be set to the ISO 639-1 Language Code (https://www.andiamo.co.uk/resources/iso-language-codes/).",
      "nullable": true
    },
    "fileData": {
      "type": "string",
      "description": "The file data.",
      "format": "binary",
      "nullable": true
    }
  }
}

File represents the editable properties of a file.

Properties

Name	Type	Required	Restrictions	Description
contentId	integer(int32)|null	false	none	The content identifier to add the file under. Passing in null will create a new piece of content alongside the file
fileId	string(guid)	false	none	The unique file id that is associated to a file stored in the system. Generate a new guid if creating a new file.
language	string|null	false	none	The language code for the file. Defaults to US English "en-us". There is no restrictions, but it is recommended that the value be set to the ISO 639-1 Language Code (https://www.andiamo.co.uk/resources/iso-language-codes/).
fileData	string(binary)|null	false	none	The file data.

ContentAggregation

{
  "type": "object",
  "description": "A group of content with various metadatas",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the aggregation",
      "nullable": true
    },
    "category": {
      "type": "string",
      "description": "Category of the aggregation",
      "nullable": true
    },
    "value": {
      "type": "string",
      "description": "Aggregation value, refers to how the content was aggregated",
      "nullable": true
    },
    "sortOrder": {
      "type": "integer",
      "description": "Where the aggregation is sorted, 0 = first",
      "format": "int32"
    },
    "contentLookup": {
      "type": "array",
      "description": "A lookup of content ids and the smart content algorithm scores tied to those",
      "nullable": true,
      "items": {
        "type": "integer",
        "format": "int32"
      }
    },
    "content": {
      "type": "array",
      "description": "The list of content tied to this aggregation",
      "nullable": true,
      "items": {
        "allOf": [
          {
            "type": "object",
            "description": "ContentInfo represents the editable properties of a piece of content.",
            "additionalProperties": false,
            "properties": {
              "title": {
                "type": "string",
                "description": "The title of the piece of content.",
                "nullable": true
              },
              "description": {
                "type": "string",
                "description": "The description of the piece of content.",
                "nullable": true
              },
              "clientDescription": {
                "type": "string",
                "description": "The description clients see for the piece of content.",
                "nullable": true
              },
              "isActive": {
                "type": "boolean",
                "description": "Whether the content is active"
              },
              "file": {
                "type": "string",
                "description": "The file that will be associated to the content.",
                "format": "binary",
                "nullable": true
              },
              "createdDateTime": {
                "type": "string",
                "description": "The date the content was created",
                "format": "date-time",
                "nullable": true
              },
              "updatedDateTime": {
                "type": "string",
                "description": "The date the file was last edited",
                "format": "date-time",
                "nullable": true
              },
              "metadata": {
                "type": "array",
                "description": "Additional dynamic information about the content.",
                "nullable": true,
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "key": {
                      "type": "string",
                      "nullable": true
                    },
                    "value": {
                      "type": "string",
                      "nullable": true
                    }
                  }
                }
              }
            }
          },
          {
            "type": "object",
            "description": "A piece of content represents a container for files and metadata in the Zywave system. Can be maintained by an agency or Zywave.",
            "additionalProperties": false,
            "properties": {
              "id": {
                "type": "integer",
                "description": "The unique Zywave identifier for the content.",
                "format": "int32"
              },
              "fileId": {
                "type": "integer",
                "description": "The unique identifier for the lastest ContentFile for the content.",
                "format": "int32"
              },
              "fileName": {
                "type": "string",
                "description": "The name of the lastest ContentFile for the content.",
                "nullable": true
              },
              "thumbnailUrl": {
                "type": "string",
                "description": "Thumbnail image source for the content.",
                "nullable": true
              },
              "tagNames": {
                "type": "array",
                "description": "A list of tags that describes what the content is.",
                "nullable": true,
                "items": {
                  "type": "string"
                }
              }
            }
          }
        ]
      }
    }
  }
}

A group of content with various metadatas

Properties

Name	Type	Required	Restrictions	Description
name	string|null	false	none	The name of the aggregation
category	string|null	false	none	Category of the aggregation
value	string|null	false	none	Aggregation value, refers to how the content was aggregated
sortOrder	integer(int32)	false	none	Where the aggregation is sorted, 0 = first
contentLookup	[integer]|null	false	none	A lookup of content ids and the smart content algorithm scores tied to those
content	[Content]|null	false	none	The list of content tied to this aggregation

ClientSize

{
  "type": "integer",
  "description": "0: Invalid,\n1: From0To25,\n2: From26To50,\n3: From51To99,\n4: From100To499,\n5: From500To999,\n6: From1000To2499,\n7: From2500To4999,\n9: MoreThan4999\n ",
  "x-enumNames": [
    "Invalid",
    "From0To25",
    "From26To50",
    "From51To99",
    "From100To499",
    "From500To999",
    "From1000To2499",
    "From2500To4999",
    "MoreThan4999"
  ],
  "enum": [
    0,
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8
  ]
}

*0: Invalid, 1: From0To25, 2: From26To50, 3: From51To99, 4: From100To499, 5: From500To999, 6: From1000To2499, 7: From2500To4999, 9: MoreThan4999 *

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer	false	none	0: Invalid, 1: From0To25, 2: From26To50, 3: From51To99, 4: From100To499, 5: From500To999, 6: From1000To2499, 7: From2500To4999, 9: MoreThan4999

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5
anonymous	6
anonymous	7
anonymous	8

LineOfBusiness

{
  "type": "integer",
  "description": "1: Benefits\n\n2: PropertyAndCasualty\n\n3: PersonalLines\n\n4: Canada\n\n5: UK",
  "x-enumNames": [
    "Benefits",
    "PropertyAndCasualty",
    "PersonalLines",
    "Canada",
    "UK"
  ],
  "enum": [
    1,
    2,
    3,
    4,
    5
  ]
}

*1: Benefits

2: PropertyAndCasualty

3: PersonalLines

4: Canada

5: UK*

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer	false	none	1: Benefits 2: PropertyAndCasualty 3: PersonalLines 4: Canada 5: UK

Enumerated Values

Property	Value
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5

USLocation

{
  "type": "integer",
  "description": "None = 0\n\nAlabama = 1\n\nAlaska = 2\n\nAmericanSomoa = 3\n\nArizona = 4\n\nArkansas = 5\n\nCalifornia = 6\n\nColorado = 7\n\nConnecticut = 8\n\nDelaware = 9\n\nDistrictOfColumbia = 10\n\nFlorida = 11\n\nGeorgia = 12\n\nGuam = 13\n\nHawaii = 14\n\nIdaho = 15\n\nIllinois = 16\n\nIndiana = 17\n\nIowa = 18\n\nKansas = 19\n\nKentucky = 20\n\nLouisiana = 21\n\nMaine = 22\n\nMaryland = 23\n\nMassachusetts = 24\n\nMichigan = 25\n\nMinnesota = 26\n\nMississippi = 27\n\nMissouri = 28\n\nMontana = 29\n\nNebraska = 30\n\nNevada = 31\n\nNewHampshire = 32\n\nNewJersey = 33\n\nNewMexico = 34\n\nNewYork = 35\n\nNorthCarolina = 36\n\nNorthDakota = 37\n\nNorthernMarianaIslands = 38\n\nOhio = 39\n\nOklahoma = 40\n\nOregon = 41\n\nPennsylvania = 42\n\nPuertoRico = 43\n\nRhodeIsland = 44\n\nSouthCarolina = 45\n\nSouthDakota = 46\n\nTennessee = 47\n\nTexas = 48\n\nUtah = 49\n\nVermont = 50\n\nVirginIslands = 51\n\nVirginia = 52\n\nWashington = 53\n\nWestVirginia = 54\n\nWisconsin = 55\n\nWyoming = 56",
  "x-enumNames": [
    "None",
    "Alabama",
    "Alaska",
    "AmericanSomoa",
    "Arizona",
    "Arkansas",
    "California",
    "Colorado",
    "Connecticut",
    "Delaware",
    "DistrictOfColumbia",
    "Florida",
    "Georgia",
    "Guam",
    "Hawaii",
    "Idaho",
    "Illinois",
    "Indiana",
    "Iowa",
    "Kansas",
    "Kentucky",
    "Louisiana",
    "Maine",
    "Maryland",
    "Massachusetts",
    "Michigan",
    "Minnesota",
    "Mississippi",
    "Missouri",
    "Montana",
    "Nebraska",
    "Nevada",
    "NewHampshire",
    "NewJersey",
    "NewMexico",
    "NewYork",
    "NorthCarolina",
    "NorthDakota",
    "NorthernMarianaIslands",
    "Ohio",
    "Oklahoma",
    "Oregon",
    "Pennsylvania",
    "PuertoRico",
    "RhodeIsland",
    "SouthCarolina",
    "SouthDakota",
    "Tennessee",
    "Texas",
    "Utah",
    "Vermont",
    "VirginIslands",
    "Virginia",
    "Washington",
    "WestVirginia",
    "Wisconsin",
    "Wyoming"
  ],
  "enum": [
    0,
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8,
    9,
    10,
    11,
    12,
    13,
    14,
    15,
    16,
    17,
    18,
    19,
    20,
    21,
    22,
    23,
    24,
    25,
    26,
    27,
    28,
    29,
    30,
    31,
    32,
    33,
    34,
    35,
    36,
    37,
    38,
    39,
    40,
    41,
    42,
    43,
    44,
    45,
    46,
    47,
    48,
    49,
    50,
    51,
    52,
    53,
    54,
    55,
    56
  ]
}

*None = 0

Alabama = 1

Alaska = 2

AmericanSomoa = 3

Arizona = 4

Arkansas = 5

California = 6

Colorado = 7

Connecticut = 8

Delaware = 9

DistrictOfColumbia = 10

Florida = 11

Georgia = 12

Guam = 13

Hawaii = 14

Idaho = 15

Illinois = 16

Indiana = 17

Iowa = 18

Kansas = 19

Kentucky = 20

Louisiana = 21

Maine = 22

Maryland = 23

Massachusetts = 24

Michigan = 25

Minnesota = 26

Mississippi = 27

Missouri = 28

Montana = 29

Nebraska = 30

Nevada = 31

NewHampshire = 32

NewJersey = 33

NewMexico = 34

NewYork = 35

NorthCarolina = 36

NorthDakota = 37

NorthernMarianaIslands = 38

Ohio = 39

Oklahoma = 40

Oregon = 41

Pennsylvania = 42

PuertoRico = 43

RhodeIsland = 44

SouthCarolina = 45

SouthDakota = 46

Tennessee = 47

Texas = 48

Utah = 49

Vermont = 50

VirginIslands = 51

Virginia = 52

Washington = 53

WestVirginia = 54

Wisconsin = 55

Wyoming = 56*

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer	false	none	None = 0 Alabama = 1 Alaska = 2 AmericanSomoa = 3 Arizona = 4 Arkansas = 5 California = 6 Colorado = 7 Connecticut = 8 Delaware = 9 DistrictOfColumbia = 10 Florida = 11 Georgia = 12 Guam = 13 Hawaii = 14 Idaho = 15 Illinois = 16 Indiana = 17 Iowa = 18 Kansas = 19 Kentucky = 20 Louisiana = 21 Maine = 22 Maryland = 23 Massachusetts = 24 Michigan = 25 Minnesota = 26 Mississippi = 27 Missouri = 28 Montana = 29 Nebraska = 30 Nevada = 31 NewHampshire = 32 NewJersey = 33 NewMexico = 34 NewYork = 35 NorthCarolina = 36 NorthDakota = 37 NorthernMarianaIslands = 38 Ohio = 39 Oklahoma = 40 Oregon = 41 Pennsylvania = 42 PuertoRico = 43 RhodeIsland = 44 SouthCarolina = 45 SouthDakota = 46 Tennessee = 47 Texas = 48 Utah = 49 Vermont = 50 VirginIslands = 51 Virginia = 52 Washington = 53 WestVirginia = 54 Wisconsin = 55 Wyoming = 56

Enumerated Values

Property	Value
anonymous	0
anonymous	1
anonymous	2
anonymous	3
anonymous	4
anonymous	5
anonymous	6
anonymous	7
anonymous	8
anonymous	9
anonymous	10
anonymous	11
anonymous	12
anonymous	13
anonymous	14
anonymous	15
anonymous	16
anonymous	17
anonymous	18
anonymous	19
anonymous	20
anonymous	21
anonymous	22
anonymous	23
anonymous	24
anonymous	25
anonymous	26
anonymous	27
anonymous	28
anonymous	29
anonymous	30
anonymous	31
anonymous	32
anonymous	33
anonymous	34
anonymous	35
anonymous	36
anonymous	37
anonymous	38
anonymous	39
anonymous	40
anonymous	41
anonymous	42
anonymous	43
anonymous	44
anonymous	45
anonymous	46
anonymous	47
anonymous	48
anonymous	49
anonymous	50
anonymous	51
anonymous	52
anonymous	53
anonymous	54
anonymous	55
anonymous	56

RecommendedContentInfo

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "contentId": {
      "type": "integer",
      "format": "int32"
    },
    "bundleId": {
      "type": "integer",
      "format": "int32"
    },
    "startDateTime": {
      "type": "string",
      "format": "date-time"
    },
    "endDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "naicsCodes": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "integer",
        "format": "int32"
      }
    },
    "clientSizeIds": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "integer",
        "format": "int32"
      }
    },
    "states": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "string"
      }
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
contentId	integer(int32)	false	none	none
bundleId	integer(int32)	false	none	none
startDateTime	string(date-time)	false	none	none
endDateTime	string(date-time)|null	false	none	none
naicsCodes	[integer]|null	false	none	none
clientSizeIds	[integer]|null	false	none	none
states	[string]|null	false	none	none