Skip to main content
PUT
Set or clear the brand's media intake address

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<shortuuid>
required

URL-safe brand identifier.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

Payload to set or clear a brand's direct media intake address.

email
string
required

The address to publish, ideally a monitored shared mailbox rather than a personal one. An empty string clears the address and its acknowledgment. A malformed address is refused with 422.

Maximum string length: 254
Pattern: ^[^\x00]{0,254}$
acknowledged
boolean
default:false

Must be true to save a non-empty address: the brand acknowledges that Closient does not receive, store, scan or filter this media, and that the brand is responsible for the content sent to the address. Saving an address without it is refused with 422. Ignored when clearing.

Response

OK

A claimed brand's direct media intake address.

email
string
required

The address consumers leaving feedback on the brand's products may send photos and video to, directly from their own mail client; empty when the brand has none and consumers reach it through Closient text and voice feedback only.

acknowledged_at
string<date-time> | null
required

ISO-8601 time the brand acknowledged the media intake notice when it saved the address; null when there is no address.