PUT user/…/third-party-id/…

Adds a third-party ID to a user account.

Modifying the details of a user account is only permitted if:

  • the calling user is an administrator (staff user) of the same organization that manages the requested user account, and
  • the calling user has MANAGE_USERS permission.

Resource URL

https://www.drillster.com/api/2.1.1/user/{user_id}/third-party-id/{third_party_id}

or

https://www.drillster.com/api/2.1.1/user/{user_id}/third-party-id/{third_party}/{id}

Response

204 (No content)

Parameters

Field Description
user_id
required
The user ID of the user. The following types can be used:

  • The account ID
  • self for the user performing the request
  • An email address registered for the user
  • A third-party ID registered for the user, using $ as separator. The value must be URL-encoded: <third-party>%24<ID>
third_party_id
required
The third-party ID to add, using $ as separator. The value must be URL-encoded: <third-party>%24<ID>.

Example value: ACME%241234
third_party
required
The third-party of the third-party ID to add.

Example value: ACME
id
required
The ID of the third-party ID to add.

Example value: 1234

Example request

PUT https://www.drillster.com/api/2.1.1/user/self/third-party-id/ACME%242058392

Error responses

The following error situations are possible:

ID Response code Description
nonexistent_user 404 (Not found) Requested user not found
no_access 403 (Forbidden) Caller does not have access to requested user
multiple_accounts 400 (Bad request) The e-mail address is used by multiple accounts
invalid_third_party_id 400 (Bad request) The provided third party ID is invalid
invalid_third_party 400 (Bad request) The specified third party can't be assigned
unauthorized_third_party 403 (Forbidden) You are not authorized to use the specified third party
third_party_id_in_use 409 (Conflict) The third party ID is already in use
third_party_already_assigned 409 (Conflict) An ID for the specified third party was already assigned to this account. An account can only have one ID per third party.