Sign in

Set social image

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Sets the image shown when someone shares a link to the app, or removes it.

Send an https URL, such as the public link from Upload app file, or null to remove the image. Leaving social_image_url out also removes it. The URL isn't fetched or checked. The published app picks up the change within moments, without a new deploy. A preview image set for a specific page takes precedence on that page, and without a social image, link previews fall back to the app's logo.

<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>

<Warning>The response includes fields beyond the ones documented here. Don't rely on undocumented response fields, as they can change at any time. Send only the fields documented here. Other request fields are not supported and their behavior can change.</Warning>

post/api/apps/{app_id}/metadata/social-image

Path parameters

app_idstring required

ID of the app to set the social image on.

ID of the app to set the social image on.

Request body

social_image_urlstring nullable

https URL of the image to show in link previews, up to 2048 characters, or null to remove the current one. Leaving it out also removes it.

Example request

{
  "social_image_url": "https://storage.base44.com/6820f3a4e7b91d003c45a1f2/7c1e9f2a_share.png"
}

Response

The app with its new social image.

idstring required

ID of the app.

social_image_urlstring nullable required

URL of the image shown when someone shares the app's link, or null when you removed it.

Example response

{
  "id": "6820f3a4e7b91d003c45a1f2",
  "social_image_url": "https://storage.base44.com/6820f3a4e7b91d003c45a1f2/7c1e9f2a_share.png"
}

Changes

Changed in 1 of the 14 revisions of this API.1