Pre-release — content may change.

Connections

Create a transfer relationship

POST
/transfer_relationships

Enqueues a background job that transfers a class of related records (e.g. touchpoints) from one person to another. The body identifies the resource_type to transfer and the from/to people. The response is the created queued job, not a connection resource; poll the returned job location for completion.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Request body for creating a transfer relationship. Identifies the class of records to transfer and the source/target people.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/transfer_relationships" \  -H "Content-Type: application/json" \  -d '{    "data": {}  }'
{  "data": {}}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}