---
title: "Refresh custom data type"
method: POST
path: "/companies/{companyId}/connections/{connectionId}/data/queue/custom/{customDataIdentifier}"
tags: ["Custom data type"]
---

# Refresh custom data type

`POST /companies/{companyId}/connections/{connectionId}/data/queue/custom/{customDataIdentifier}`

The *Refresh custom data type* endpoint refreshes the specified custom data type for a given company. This is an asynchronous operation that will sync updated data from the linked integration into Codat for you to view.

## Response `200`

OK

- PullOperation — Information about a queued, in progress or completed pull operation. *Formally called `dataset`*
  - `id` string, uuid, required — Unique identifier of the pull operation.
  - `companyId` string, uuid, required — Unique identifier of the company associated to this pull operation.
  - `connectionId` string, uuid, required — Unique identifier of the connection associated to this pull operation.
  - `dataType` string, required — The data type you are requesting in a pull operation.
  - `status` 'Initial' | 'Queued' | 'Fetching' | 'MapQueued' | 'Mapping' | 'Complete' | 'FetchError' | 'MapError' | 'InternalError' | 'ProcessingQueued' | 'Processing' | 'ProcessingError' | 'ValidationQueued' | 'Validating' | 'ValidationError' | 'AuthError' | 'Cancelled' | 'NotSupported' | 'RateLimitError' | 'PermissionsError' | 'PrerequisiteNotMet', required — The current status of the dataset.
  - `statusDescription` string, nullable — Additional information about the dataset status.
  - `errorMessage` string, nullable — A message about a transient or persistent error returned by Codat or the source platform.
  - `requested` string, required — In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example: ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` > Time zones > > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
  - `completed` string — In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example: ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` > Time zones > > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
  - `progress` integer, required — An integer signifying the progress of the pull operation.
  - `isCompleted` boolean, required — `True` if the pull operation is completed successfully. The `isCompleted` property is not queryable. To filter failed pull operations, query by `status!=Complete&&status!=NotSupported` instead.
  - `isErrored` boolean, required — `True` if the pull operation entered an error state.

## Other responses

- `401` — Your API request was not properly authorized.
- `402` — An account limit has been exceeded. The type of limit is described in the error property: - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io.
- `403` — You are using an outdated API key or a key not associated with that resource.
- `404` — One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted.
- `429` — Too many requests were made in a given amount of time. Wait a short period and then try again.
- `451` — Not currently available due to compliance limitations. Reach out to your Codat contact for further assistance.
- `500` — There is a problem with our server. Please try again later.
- `503` — The Codat API is temporarily offline for maintenance. Please try again later.

---

[API](https://skmtc.dev/codatio/apis/platform-api.md) · [All operations](https://skmtc.dev/codatio/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/codatio/platform-api/revisions/bff9b9776ecf/schema)