Update a Connect Connection

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

connection-idstringRequired

Token of the connect connection

Headers

Query parameters

fieldsmap from strings to stringsOptional

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See [Serialization](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details.

Request

This endpoint expects an object.

dataobjectOptional

Response

This endpoint returns a Connect Connection.

dataobject

A Connect Connection object. This object represents a connection between organizations for sharing access to Persona objects.

1	{
2	"data": {
3	"type": "connect/connection",
4	"id": "cxn_ABC123",
5	"attributes": {
6	"token": "cxn_ABC123",
7	"name": "Partner Connection",
8	"status": "active",
9	"organization-id": "org_ABC123",
10	"destination-organization-id": "org_DEF456",
11	"scopes": [
12	"inquiry.read",
13	"account.read"
14	],
15	"creator-id": "api_ABC123",
16	"creator-type": "api-key",
17	"created-at": "2018-06-01T00:00:00.000Z",
18	"updated-at": "2018-06-01T00:00:00.000Z"
19	}
20	}
21	}

1	{
2	"data": {
3	"type": "connect/connection",
4	"id": "cxn_ABC123",
5	"attributes": {
6	"token": "cxn_ABC123",
7	"name": "Partner Connection",
8	"status": "active",
9	"organization-id": "org_ABC123",
10	"destination-organization-id": "org_DEF456",
11	"scopes": [
12	"inquiry.read",
13	"account.read"
14	],
15	"creator-id": "api_ABC123",
16	"creator-type": "api-key",
17	"created-at": "2018-06-01T00:00:00.000Z",
18	"updated-at": "2018-06-01T00:00:00.000Z"
19	}
20	}
21	}

1	curl -X PATCH https://api.withpersona.com/api/v1/connect/connections/cxn_ABC123 \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json"