/mail/avatars/lookup

POST

const url = 'https://example.com/api/v1/mail/avatars/lookup';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"addresses":["example"]}'
};

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

curl --request POST \
  --url https://example.com/api/v1/mail/avatars/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "addresses": [ "example" ] }'

Authorizations

bearer

Request Body^required

application/json

object

addresses

required

Array<string>

<= 200 items

Example^generated

{
  "addresses": [
    "example"
  ]
}

Responses

200

Default Response

application/json

Array<object>

object

address

required

string

colour

required

string

Allowed values: grey red amber green teal blue violet pink

picture

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

Example

[
  {
    "colour": "grey"
  }
]

/mail/avatars/lookup

Authorizations

Request Bodyrequired

Examplegenerated

Responses

200

Example

Request Body^required

Example^generated