Adds a new social account to a user's account.

Request

HTTP request

PUT /v2/accounts/{accountId}/users/{userId}/social

Parameters

Parameter name Value Description
Path parameters
accountId string

The external account number (int) or account ID Guid.

userId string

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Authentication::updateSocialLogin

Definitions Expand All | Collapse All

UserSocialAccountLogins

Users' social account logins

email string

The users email address.

errorDetails errorDetails
provider string

The social account provider (Facebook, Yahoo, etc.)

socialId string

The ID provided by the Socal Account.

userName string

The full user name for the account.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

Examples

Generic JSON Request

Request

{
"provider": "sample string 1",
"email": "sample string 2",
"socialId": "sample string 3",
"userName": "sample string 4"
}

Generic XML Request

Request

<socialAccountInformation 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<email>sample string 2</email>
<provider>sample string 1</provider>
<socialId>sample string 3</socialId>
<userName>sample string 4</userName>
</socialAccountInformation>