Update an app

PATCH

1 curl -X PATCH https://api.x.flatfile.com/v1/apps/us_app_YOUR_ID \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "name": "Nightly Data Loads",
7   "namespace": "nightly-data",
8   "entity": "Sync",
9   "entityPlural": "Syncs",
10   "icon": "<svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"currentColor\" class=\"bi bi-bar-chart-fill\" viewBox=\"0 0 16 16\">\n  <path d=\"M1 11a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v3a1 1 0 0 1-1 1H2a1 1 0 0 1-1-1zm5-4a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H7a1 1 0 0 1-1-1zm5-5a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v12a1 1 0 0 1-1 1h-2a1 1 0 0 1-1-1z\"/>\n</svg>",
11   "metadata": {
12     "foo": "bar"
13   }
14 }'

Play

200Example0

1 {
2   "data": {
3     "id": "us_app_YOUR_ID",
4     "name": "Nightly Data Loads",
5     "namespace": "nightly-data",
6     "type": "CUSTOM",
7     "entity": "Sync",
8     "entityPlural": "Syncs",
9     "metadata": {
10       "foo": "bar"
11     },
12     "environmentFilters": {
13       "type": [
14         "PROD",
15         "DEV"
16       ],
17       "exclude_ids": [
18         "us_env_123456"
19       ]
20     },
21     "createdAt": "2023-10-30T16:59:45.735Z",
22     "updatedAt": "2023-10-30T16:59:45.735Z",
23     "icon": "<svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"currentColor\" class=\"bi bi-bar-chart-fill\" viewBox=\"0 0 16 16\">\n  <path d=\"M1 11a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v3a1 1 0 0 1-1 1H2a1 1 0 0 1-1-1zm5-4a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v7a1 1 0 0 1-1 1H7a1 1 0 0 1-1-1zm5-5a1 1 0 0 1 1-1h2a1 1 0 0 1 1 1v12a1 1 0 0 1-1 1h-2a1 1 0 0 1-1-1z\"/>\n</svg>",
24     "deletedAt": null,
25     "activatedAt": null
26   }
27 }

Updates an app

Path parameters

appIdstringRequired

ID of app

Request

This endpoint expects an object.

namestringOptional

namespacestringOptional

entitystringOptional

entityPluralstringOptional

iconstringOptional

metadataanyOptional

environmentFiltersanyOptional

blueprintanyOptional

activatedAtdatetimeOptional

Response

This endpoint returns an object.

dataobject

An app

Path parameters

Headers

Request

Response