Lists

Add an avatar for a list

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Lists/uploadListAvatar" target="_blank">Try in sandbox</a><br>Add an avatar for a list

post/api/v2/lists/{id}/avatar

Request

Base URL
https://rest.textmagic.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/textmagic/apis/textmagic-api/docs/api/v2/lists/:id/avatar/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

Request body multipart/form-data

imagestring binary required

List avatar. Should be a PNG or JPG file not more than 10 MB.

Response

Avatar uploaded with success.

idinteger required

Resource ID.

hrefstring required

A link to this resource. If you want to fetch it, just GET this address.

Example response

{
  "id": 515,
  "href": "/api/v2/entity_name/1"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.