Skip to content
OpenBot

channelLinks.acceptChannelLink

POST
/v1/channel-links/{code}/accept
curl --request POST \
  --url https://example.com/v1/channel-links/example/accept \
  --header 'Authorization: Bearer <token>'

Links the person on the platform to the caller. A code works only once.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
code
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
channel
required
string
>= 1 characters <= 128 characters
externalUserId
required
string
displayName
required
string
userId
required
string
createdAt
required
number

Example generated

{
  "channel": "example",
  "externalUserId": "example",
  "displayName": "example",
  "userId": "example",
  "createdAt": 1
}

400

Section titled “400”

OrganizationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: OrganizationRequired

Example 

{
  "_tag": "OrganizationRequired"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

Section titled “404”

ChannelLinkInvalid | ChannelIdentityNotFound

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ChannelLinkInvalid

Example 

{
  "_tag": "ChannelLinkInvalid"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

AuthorizationUnavailable | ChannelsUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AuthorizationUnavailable

Example 

{
  "_tag": "AuthorizationUnavailable"
}