Inbox details

Get the details of an inbox

{ "identifier": "string", "name": "string", "timezone": "string", "working_hours": [ { "day_of_week": 0, "open_all_day": true, "closed_all_day": true, "open_hour": 0, "open_minutes": 0, "close_hour": 0, "close_minutes": 0 } ], "working_hours_enabled": true, "csat_survey_enabled": true, "greeting_enabled": true, "identity_validation_enabled": true }

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

identifier

string

optional

Inbox identifier

name

string

optional

Name of the inbox

timezone

string

optional

The timezone defined on the inbox

working_hours

array [object {7}]

optional

The working hours defined on the inbox

day_of_week

integer

optional

Day of the week as a number. Sunday -> 0, Saturday -> 6

open_all_day

boolean

optional

Whether or not the business is open the whole day

closed_all_day

boolean

optional

Whether or not the business is closed the whole day

open_hour

integer

optional

Opening hour. Can be null if closed all day

open_minutes

integer

optional

Opening minute. Can be null if closed all day

close_hour

integer

optional

Closing hour. Can be null if closed all day

close_minutes

integer

optional

Closing minute. Can be null if closed all day

working_hours_enabled

boolean

optional

Whether of not the working hours are enabled on the inbox

csat_survey_enabled

boolean

optional

Whether of not the Customer Satisfaction survey is enabled on the inbox

greeting_enabled

boolean

optional

Whether of not the Greeting Message is enabled on the inbox

identity_validation_enabled

boolean

optional

Whether of not the User Identity Validation is enforced on the inbox

🟠401Unauthorized

🟠404Record Not Found

Request

Responses