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

• token
• session

Parameters

Path Parameters

code

required

string

Responses

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

OrganizationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "OrganizationRequired"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "Forbidden"
}

404

ChannelLinkInvalid | ChannelIdentityNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ChannelLinkInvalid

object

object

_tag

required

string

Allowed values: ChannelIdentityNotFound

Example

{
  "_tag": "ChannelLinkInvalid"
}

409

@nmnmcc/ability/Authorizer/Pending

Media typeapplication/json

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ChannelsUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: ChannelsUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "PolicyUnavailable"
}