> This page is for API, version 2026-01-01 (Stable) (default).
> For other versions, use one of these documentation indexes:
> - 2026-01-01 (Stable) (default): https://developer.deel.com/api/stable/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.deel.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.deel.com/_mcp/server.

# Update the listing of an app

PATCH https://api.letsdeel.com/rest/oauth2-apps/{app_id}/listing
Content-Type: application/json

Saves changes to the App Store page of an app as a draft revision. Send only the fields you want to change; each list you send replaces the current one. The draft goes live only after you submit it and Deel approves it. Fails while a revision is in review. Returns the listing.

 **Token scopes**: `apps:write`

 **Beta**: this version requires the `X-Beta: true` request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-02-17.

Reference: https://developer.deel.com/api/reference/endpoints/apps/update-app-listing-v-2026-11-17

## Authentication

- `Authorization` header (bearer token, required) — ## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
- `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

## Servers

- `https://api.letsdeel.com/rest` (Production, default)
- `https://api-staging.letsdeel.com/rest` (Demo)

## Request

### Path parameters

- `app_id` (string, required) — Unique identifier of the app.

### Headers

- `X-Beta` (enum, required, default: true) — Opts in to the beta version of this endpoint. Must be `true`.
  - Allowed values: `true`

### Body (application/json)

This endpoint expects an object.

- `data` (Oauth2AppsAppIdListingPatchRequestBodyContentApplicationJsonSchemaData, required) — The fields to change. Send at least one; fields you leave out keep their value. The changes are saved as a draft revision that you send to review with the submit call.

## Response

### 200

The listing with your changes saved as a draft revision.

- `data` (Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaData, required) — The App Store listing of an app.

## Errors

### 400 Bad Request Error

Bad Request. A field is invalid or cannot be changed, or the logo file cannot be used.

- `errors` (list of Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail.

### 401 Unauthorized Error

Unauthorized. Authentication credentials were missing or invalid.

- `errors` (list of Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail.

### 403 Forbidden Error

Forbidden. You do not have permission to access this resource.

- `errors` (list of Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail.

### 404 Not Found Error

Not Found. No app with this id belongs to your organization, or it has no listing yet.

- `errors` (list of Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail.

### 409 Conflict Error

Conflict. A revision is in review, so the listing cannot be changed until the review ends.

- `errors` (list of Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail.

### 429 Too Many Requests Error

Too Many Requests. The rate limit has been exceeded.

- `errors` (list of Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail.

### 500 Internal Server Error

Internal Server Error. An unexpected error occurred.

- `errors` (list of Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaErrorsItems, required) — The list of errors that caused the request to fail.

## Types

### Oauth2AppsAppIdListingPatchRequestBodyContentApplicationJsonSchemaData

The fields to change. Send at least one; fields you leave out keep their value. The changes are saved as a draft revision that you send to review with the submit call.

- `logo` (Oauth2AppsAppIdListingPatchRequestBodyContentApplicationJsonSchemaDataLogo, optional) — The logo, as the file you registered with POST /files and uploaded. Send the file_id and one_time_secret that call returned, once the file status is ready. The logo is shown in the App Store only after Deel approves the listing.
- `faq_url` (string, optional) — FAQ of the app.
- `categories` (list of integer, optional) — Ids of the App Store categories, from GET /app-store/categories. At most 3; the submit needs at least one. The list you send replaces the current one.
- `highlights` (list of Oauth2AppsAppIdListingPatchRequestBodyContentApplicationJsonSchemaDataHighlightsItems, optional) — Highlights shown on the store page. At most 3; the submit needs at least one, each with a title and a text. The list you send replaces the current one.
- `works_with` (list of Oauth2AppsAppIdListingPatchRequestBodyContentApplicationJsonSchemaDataWorksWithItems, optional) — The Deel products the app works with, each at most once. The list you send replaces the current one.
- `how_it_works` (string, optional) — How the app works.
- `support_email` (string, optional) — Where customers reach your support.
- `what_it_syncs` (list of string, optional) — What the app syncs. The list you send replaces the current one.
- `demo_video_url` (string, optional) — Demo video of the app.
- `escalation_email` (string, optional) — Where Deel escalates urgent issues.
- `landing_page_url` (string, optional) — Landing page of the app.
- `short_description` (string, optional) — Tagline shown on the listing card.
- `support_resources` (list of Oauth2AppsAppIdListingPatchRequestBodyContentApplicationJsonSchemaDataSupportResourcesItems, optional) — Support links shown on the store page. The submit needs at least one. The list you send replaces the current one.
- `pricing_description` (string, optional) — What the app costs.
- `product_description` (string, optional) — What the app does.
- `test_account_details` (string, optional) — How Deel signs in to your app to test it. The submit needs it. It is kept private: no response ever returns it.
- `main_description_body` (string, optional) — Body of the main description on the store page.
- `main_description_title` (string, optional) — Title of the main description on the store page.

### Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaData

The App Store listing of an app.

- `name` (string, required) — Name of the listing in the App Store.
- `app_id` (string, required) — Unique identifier of the app the listing belongs to.
- `status` (enum, required) — Whether the listing is live in the App Store. It stays `published` while a newer revision is reviewed.
  - Allowed values: `published`, `unpublished`
- `faq_url` (string, required, nullable) — FAQ of the app.
- `logo_url` (string, required, nullable) — URL of the logo of the revision in `latest_revision`, as saved. Null only when no logo has been set. For some older listings the URL is a temporary link that stops working after about an hour.
- `categories` (list of Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaDataCategoriesItems, required) — App Store categories of the revision.
- `highlights` (list of Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaDataHighlightsItems, required) — Highlights shown on the store page.
- `works_with` (list of Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaDataWorksWithItems, required) — Deel products the app works with.
- `how_it_works` (string, required, nullable) — How the app works.
- `media_gallery` (list of Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaDataMediaGalleryItems, required) — Images and videos of the revision in `latest_revision`, as saved. Empty when none has been set.
- `support_email` (string, required, nullable) — Where customers reach your support.
- `what_it_syncs` (list of string, required) — What the app syncs.
- `demo_video_url` (string, required, nullable) — Demo video of the app.
- `latest_revision` (Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaDataLatestRevision, required, nullable) — The version of the listing you are working on or that is under review. Null until the listing has content.
- `escalation_email` (string, required, nullable) — Where Deel escalates urgent issues.
- `landing_page_url` (string, required, nullable) — Landing page of the app.
- `short_description` (string, required, nullable) — Tagline shown on the listing card.
- `support_resources` (list of Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaDataSupportResourcesItems, required) — Support links shown on the store page.
- `first_published_at` (string, required, nullable) — When the listing was first approved. Null until then.
- `pricing_description` (string, required, nullable) — What the app costs.
- `product_description` (string, required, nullable) — What the app does.
- `main_description_body` (string, required, nullable) — Body of the main description on the store page.
- `main_description_title` (string, required, nullable) — Title of the main description on the store page.

### Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaErrorsItems

- `code` (string, required) — Machine-readable error code.
- `message` (string, required) — Human-readable description of the error.
- `details` (Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaErrorsItemsDetails, optional) — Additional information about the error, when available.

### Oauth2AppsAppIdListingPatchRequestBodyContentApplicationJsonSchemaDataLogo

The logo, as the file you registered with POST /files and uploaded. Send the file_id and one_time_secret that call returned, once the file status is ready. The logo is shown in the App Store only after Deel approves the listing.

- `file_id` (string, required) — Identifier of the uploaded file.
- `one_time_secret` (string, required) — The secret returned when the file was registered. It can be used once.

### Oauth2AppsAppIdListingPatchRequestBodyContentApplicationJsonSchemaDataHighlightsItems

- `text` (string, required) — Text of the highlight.
- `title` (string, optional) — Title of the highlight.

### Oauth2AppsAppIdListingPatchRequestBodyContentApplicationJsonSchemaDataWorksWithItems

- `url` (enum, required) — Official address of that product, exactly as Deel lists it.
  - Allowed values: `https://www.deel.com/solutions/payroll/`, `https://www.deel.com/solutions/hr/`, `https://www.deel.com/solutions/benefits/`, `https://www.deel.com/solutions/it/`, `https://www.deel.com/solutions/hire/`, `https://www.deel.com/solutions/mobility/`, `https://www.deel.com/solutions/payroll/peo/`, `https://www.deel.com/solutions/payroll/eor/`, `https://www.deel.com/solutions/payroll/contractors/`
- `name` (enum, required) — Name of the Deel product.
  - Allowed values: `Deel Payroll`, `Deel HR`, `Deel Benefits`, `Deel IT`, `Deel Hire`, `Deel Mobility`, `Deel PEO`, `Deel EOR`, `Deel Contractors`

### Oauth2AppsAppIdListingPatchRequestBodyContentApplicationJsonSchemaDataSupportResourcesItems

- `url` (string, required) — Address of the link.
- `name` (string, required) — Name of the link.

### Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaDataCategoriesItems

- `id` (integer, optional) — Unique identifier of the category.
- `name` (string, optional) — Name of the category.

### Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaDataHighlightsItems

- `text` (string, optional) — Text of the highlight.
- `title` (string, optional, nullable) — Title of the highlight.

### Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaDataWorksWithItems

- `url` (string, optional, nullable) — Address of the link.
- `name` (string, optional) — Name of the link.

### Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaDataMediaGalleryItems

- `url` (string, optional) — Public URL of the item.
- `type` (enum, optional) — Whether the item is an image or a video.
  - Allowed values: `image`, `video`
- `caption` (string, optional, nullable) — Caption of the item.

### Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaDataLatestRevision

The version of the listing you are working on or that is under review. Null until the listing has content.

- `status` (enum, optional) — Where the revision stands. Only a draft can be edited and submitted.
  - Allowed values: `draft`, `in_review`, `published`, `rejected`
- `review_notes` (string, optional, nullable) — The reviewer’s notes when the revision was rejected.

### Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaDataSupportResourcesItems

- `url` (string, optional, nullable) — Address of the link.
- `name` (string, optional) — Name of the link.

### Oauth2AppsAppIdListingPatchResponsesContentApplicationJsonSchemaErrorsItemsDetails

Additional information about the error, when available.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "data": {
    "name": "Payroll sync",
    "app_id": "00000000-0000-0000-0000-000000000000",
    "status": "published",
    "faq_url": "https://example.com/faq",
    "logo_url": "https://assets.example.com/logos/abc/logo.png",
    "categories": [
      {
        "id": 182,
        "name": "Collaboration"
      }
    ],
    "highlights": [
      {
        "text": "Syncs every hour",
        "title": "Automatic sync"
      }
    ],
    "works_with": [
      {
        "url": "https://example.com/docs",
        "name": "Setup guide"
      }
    ],
    "how_it_works": "Sign in and authorize.",
    "media_gallery": [
      {
        "url": "https://assets.example.com/gallery/abc/screenshot.png",
        "type": "image",
        "caption": "Dashboard"
      }
    ],
    "support_email": "support@example.com",
    "what_it_syncs": [
      "Worker Profiles"
    ],
    "demo_video_url": "https://example.com/demo",
    "latest_revision": {
      "status": "in_review",
      "review_notes": "Add a support email and a demo video, then resubmit."
    },
    "escalation_email": "escalations@example.com",
    "landing_page_url": "https://example.com",
    "short_description": "Sync timesheets to payroll",
    "support_resources": [
      {
        "url": "https://example.com/docs",
        "name": "Setup guide"
      }
    ],
    "first_published_at": "2026-10-26T10:30:00.000Z",
    "pricing_description": "Free for Deel customers.",
    "product_description": "Syncs approved timesheets to your payroll system.",
    "main_description_body": "<p>Keep payroll in sync.</p>",
    "main_description_title": "Payroll sync"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.letsdeel.com/rest/oauth2-apps/00000000-0000-0000-0000-000000000000/listing"

payload = {}
headers = {
    "X-Beta": "true",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.letsdeel.com/rest/oauth2-apps/00000000-0000-0000-0000-000000000000/listing';
const options = {
  method: 'PATCH',
  headers: {
    'X-Beta': 'true',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.letsdeel.com/rest/oauth2-apps/00000000-0000-0000-0000-000000000000/listing"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Beta", "true")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.letsdeel.com/rest/oauth2-apps/00000000-0000-0000-0000-000000000000/listing")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-Beta"] = 'true'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.letsdeel.com/rest/oauth2-apps/00000000-0000-0000-0000-000000000000/listing")
  .header("X-Beta", "true")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.letsdeel.com/rest/oauth2-apps/00000000-0000-0000-0000-000000000000/listing', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'X-Beta' => 'true',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.letsdeel.com/rest/oauth2-apps/00000000-0000-0000-0000-000000000000/listing");
var request = new RestRequest(Method.PATCH);
request.AddHeader("X-Beta", "true");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Beta": "true",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/oauth2-apps/00000000-0000-0000-0000-000000000000/listing")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```