GET/users/{userId}/link-url

Gets a URL that allows LINE WORKS or LINE users to add a member as an external contact.

Caution

  • The API operation gets only the users who have permission to chat with external accounts.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

user
user.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/link-url

Path Parameters

ParameterTypeDescription
userId string 

Member ID
- Email address
- Resource ID
- External key in "externalKey:{externalKey}" format


required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
userId string 

Member ID


readOnly : true 
linkUrl string 

URL for adding an external message contact

 

Response Example

example

1{2  "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",3  "linkUrl": "https://works.do/RaNdomW"4}

HTTP 403

Forbidden

HTTP 404

Not Found