channels.deleteChannelIdentity

DELETE

/v1/organization/channels/{channelId}/identities/{externalUserId}

const url = 'https://example.com/v1/organization/channels/example/identities/example';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://example.com/v1/organization/channels/example/identities/example \
  --header 'Authorization: Bearer <token>'

Unlinks a person. The bot asks them to link again.

Authorizations

token
session

Parameters

Path Parameters

channelId

required

string

>= 1 characters <= 128 characters

externalUserId

required

string

Responses

204

400

ChannelInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ChannelInvalid

message

required

string

Example

{
  "_tag": "ChannelInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionForbidden

Example

{
  "_tag": "ExecutionForbidden"
}

404

ExecutionNotFound | ChannelNotFound | ChannelIdentityNotFound

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionNotFound

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionNotFound"
}

409

ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending | ChannelConflict

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionConflict

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionConflict"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExecutionUnavailable | ChannelsUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionUnavailable

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionUnavailable"
}