Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update body to reflect actual response


Excerpt

Connects an entity/account to a track

...


Endpoint ID:1007
Method:

Status
colourGreen
titlePOST

URL:

/userentity/dp-keyid/{dpentity-keyid}/tracks/{track-id}

/userentity/ext-key/{ext-key}/{ext-type}/tracks/{track-id} 


 

dp-key  

dialogportal™ master key entity-id

Rubiq entity ID that uniquely identifies an account to connect with specified track

 


ext-key

External key that uniquely identifies an account to connect with specified track

 


ext-typeType of external key 

track-idID of track to connect account with
Request body:None


Span
stylewhite-space:pre
Response body:


JSON data with information about the newly created connection

Code Block
title
Example – Account with dialogportal™ master key 12345 was just successfully connected to track with 397:
{
	"
dpKey": 12345, "
trackID": 397,
	"name": "Name of track",
	"
type
connection":
"…",
 
"connected":
true
}


Status codes:201

Connection created successfully

 


303

Account is already connected to the specified track

 


404

Account was not found or track was not found.

The following sub codes may be returned:

404.1User not found
404.2External user could not be found
404.4Track not found