Profile photos

Use these methods to manage client profile photos via the Back Office.

GET[host]/api/v2/clients/{clientId}/photo

Get a client profile photo

POST[host]/api/v2/clients/{clientId}/photo

Upload a client profile photo

DELETE[host]/api/v2/clients/{clientId}/photo

Delete a client profile photo

Get a client profile photo

Use this method to obtain a photo uploaded to a client profile.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters

clientID required

The client identifier.

size

The image size in which you want to return a profile photo, in kilobytes (KB). The default value is 200.

GET[host]/api/v2/clients/{clientId}/photo

curl --location --request GET 'https://host.name/api/v2/clients/clientId/photo?size=200' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response includes a binary image that corresponds to the query parameters specified in the request.

Upload a client profile photo

Use this method to upload a photo to a client profile. Supported image formats are GIF, JPEG and PNG.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

clientId required

The client identifier.

POST[host]/api/v2/clients/{clientId}/photo

curl --location --request POST 'https://host.name/api/v2/clients/clientId/photo \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja' \
--form 'photo=@"/path/to/file"'

Response

In case of success, no response body is returned.

Delete a client profile photo

Use this method to delete a photo from a client profile.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

clientId required

The client identifier.

DELETE[host]/api/v2/clients/{clientId}/photo

curl --location --request DELETE 'https://host.name/api/v2/clients/clientId/photo \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.