Admit specific person through channel
Requests admission for a specific person through a channel.
This checks if the person has valid credentials and access rights before admitting.
Returns an admission_request_id for tracking via GET /api/3/admission_requests/:id.
/api/3/channels/{id}/admit_person
Authentication
This endpoint requires authentication:
Use an OAuth 2.0 access token in the Authorization header. This is the recommended authentication method for all integrations. OAuth provides automatic token expiration, granular permission scopes, detailed usage tracking, and per-integration revocation. Learn how to obtain an access token.
Header Format:
Authorization: Bearer YOUR_ACCESS_TOKEN
Required Scopes:
account.channel.admit.person
Parameters
Path Parameters
id
integer
Channel ID
Request Body
person_id
integer
ID of the person to admit
Example
{
"person_id": 12345
}Responses
Admission request accepted
Response Fields
admission_request_id
integer
ID of the admission request for status tracking
eg. 123456789
status
string
Initial status of the admission
eg. pending
Unauthorized - Invalid or missing authentication
Response Fields
error
string
eg. unauthorized
error_description
string
eg. The access token is invalid
Forbidden - Person does not have access or is not authorized
Response Fields
error
string
eg. Access denied
reason
string
Reason for denial
eg. Person does not have valid credentials for this channel
Not Found - Resource does not exist or is not an admission request event
Response Fields
error
string
eg. not_found
error_description
string
eg. The requested resource was not found
Internal Server Error
Response Fields
error
string
eg. internal_server_error
error_description
string
eg. An unexpected error occurred
Mentioned in Guides
This endpoint is used in the following guides: