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

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

userIdstring

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. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

Responses

CodeDescriptionReference
200

Successful response.

400

Error encountered.

errorDetails

SDK Method

Authentication::updateSocialLogin

Definitions

errorDetails

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

errorCodestring

An error code associated with the error.

messagestring

A short error message.

UserSocialAccountLogins

Users' social account logins

emailstring

The users email address.

errorDetailserrorDetails

providerstring

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

socialIdstring

The ID provided by the Socal Account.

userNamestring

The full user name for the account.

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> 
}} />