Skip to content

Assign Mailbox To Team

POST
/teams/{team_id}/mailboxes

Attach a mailbox to a team. Everyone on the team may then send from it.

object_id is the integer mailboxes.id from GET /teams/available/mailboxes, not the mailbox address.

Authorizations

Parameters

Path Parameters

team_id
required

Team id (UUID).

string

Team id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Attach a mailbox or a phone number. Mirrors teams.AssignObjectDTO.

object
object_id
required

Integer id of the mailbox or phone number to attach.

integer

Responses

200

Successful Response

object
data
required

An open envelope for a single role, team, member or account record.

Open on purpose. The app’s own response models on this surface grow with the product - RoleResponse gained rep_limits and manages_role_slugs, TeamResponse gained channel counts and a campaign count - and a pinned mirror would SILENTLY DROP whatever it had not caught up on. A dropped permission in a role read is the worst possible kind of stale: it reads as “they do not have it”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string