Organisation

Update organisation cover image

POST/v4/onboard/platform/organisation/coverimage

Replaces the cover image of the organisation of the API key or token. Send the image as multipart/form-data in the orgimage field: a PNG, JPEG, GIF or WebP image (the service reads the type from the bytes) of at most 5 MiB and 4096 x 4096 pixels (the defaults of the installation).

The service stores the image and sets a new coverImageId; the coverImageUrl of Read organisation then points to it. The organisation wallet gets the new image a moment after the response.

Language of the request sample

curl -X POST 'https://demo-api.igrant.io/v4/onboard/platform/organisation/coverimage' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -F 'orgimage=@/path/to/file'

No body.

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:organisation:update

Body

multipart/form-data

The new cover image.

orgimagefilerequired
The image file (PNG, JPEG, GIF or WebP).

Response

The image is stored. The response body is empty.

No body.