Use this API to define and manage external content types. A type refers to a kind of content, such as blog posts, tech notes, or bug reports. Because end users can filter help center search results by content type, use descriptive names to help them understand and navigate your content.

For more information on federated search, see Introduction and Setting up Zendesk Federated Search in your help center in Zendesk help.

JSON Format

Types are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
created_at string false false ISO-8601 compliant date-time reflecting the time the event was created. If not set, the API sets the value when it receives the event
id string true false Universally Unique Lexicographically Sortable Identifier. See https://github.com/ulid/spec
name string false true The name of the type to be displayed in the help center
updated_at string false false ISO-8601 compliant date-time reflecting the time the event was last updated

List External Content Types

  • GET /api/v2/guide/external_content/types

Returns a list of the external content types created for this account.

Allowed For

  • Help Center managers

Parameters

Name Type In Required Description
page object Query false Paginate query

Using curl

curl https://{subdomain}.zendesk.com/api/v2/guide/external_content/types \  -v -u {email_address}:{password}

Example Response

Status 200 OK
{  "meta": {    "after_cursor": "MG",    "before_cursor": "MQ",    "has_more": true  },  "types": [    {      "created_at": "2020-05-01T09:12:20Z",      "id": "01EBDWWC98ZF7DK9YQF3DK9Y77",      "name": "Book",      "updated_at": "2020-05-26T09:11:30Z"    }  ]}

Show External Content Type

  • GET /api/v2/guide/external_content/types/{id}

Returns the specified content type.

Allowed For

  • Help Center managers

Parameters

Name Type In Required Description
id string Path true ULID for the object

Using curl

curl https://{subdomain}.zendesk.com/api/v2/guide/external_content/types/{id} \  -v -u {email_address}:{password}

Example Response

Status 200 OK
{  "type": {    "created_at": "2020-05-01T09:12:20Z",    "id": "01E7H2DC2EDTK45NZTFGFAAA1N",    "name": "Book",    "updated_at": "2020-05-26T09:11:30Z"  }}

Create External Content Type

  • POST /api/v2/guide/external_content/types

Creates an external content type.

Allowed For

  • Help Center managers

Example Body

{  "type": {    "name": "Book"  }}

Using curl

curl https://{subdomain}.zendesk.com/api/v2/guide/external_content/types \  -d '{"type": { "name": "Book" }}' \  -H "Content-Type: application/json" \  -v -u {email_address}:{password} -X POST

Example Response

Status 201 Created
{  "type": {    "created_at": "2020-05-01T09:12:20Z",    "id": "01E7H2DC2EDTK45NZTFGFAAA1N",    "name": "Book",    "updated_at": "2020-05-26T09:11:30Z"  }}

Update External Content Type

  • PUT /api/v2/guide/external_content/types/{id}

Updates the specified external content type with the request body.

Allowed For

  • Help Center managers

Parameters

Name Type In Required Description
id string Path true ULID for the object

Example Body

{  "type": {    "name": "Book"  }}

Using curl

curl https://{subdomain}.zendesk.com/api/v2/guide/external_content/types/{id} \  -d '{"type": { "name": "Book" }}' \  -H "Content-Type: application/json" \  -v -u {email_address}:{password} -X PUT

Example Response

Status 200 OK
{  "type": {    "created_at": "2020-05-01T09:12:20Z",    "id": "01E7H2DC2EDTK45NZTFGFAAA1N",    "name": "Book",    "updated_at": "2020-05-26T09:11:30Z"  }}

Delete External Content Type

  • DELETE /api/v2/guide/external_content/types/{id}

Deletes the specified external content type.

Allowed For

  • Help Center managers

Parameters

Name Type In Required Description
id string Path true ULID for the object

Using curl

curl https://{subdomain}.zendesk.com/api/v2/guide/external_content/types/{id} \  -v -u {email_address}:{password} -X DELETE

Example Response

Status 204 No Content