Create Connect | Chariot

Get an existing connect or create a new connect for an existing nonprofit organization.

The returned Connect can be used to integrate the client-side Chariot Connect component using the id property (CID) and also query for data generated from the Chariot Connect instance from the Chariot API using the x-chariot-api-key header parameter.

Only one Connect object can be created per Nonprofit. If one already exists, this will return a 200 OK status with the existing object.

Get an existing connect or create a new connect for an existing nonprofit organization. The returned Connect can be used to integrate the client-side Chariot Connect component using the `id` property (CID) and also query for data generated from the Chariot Connect instance from the Chariot API using the `x-chariot-api-key` header parameter. <Note> Only one Connect object can be created per Nonprofit. If one already exists, this will return a `200 OK` status with the existing object. </Note>

Query parameters

nonprofitstringRequiredformat: "uuid"

The unique id of the nonprofit. The format should be a v4 UUID according to RFC 4122.

suborganizationstringOptionalformat: "uuid"

The unique id for the suborganization within the nonprofit. The format should be a v4 UUID according to RFC 4122.

Request

The request to create a new Connect object for a Nonprofit.

namestringOptional

A human readable name of the Connect, optional.

metadatamap from strings to stringsOptional

A map of arbitrary string keys and values to store information about the object.

Response

idstringRead-only

The unique identifier for this object. This is also the ‘publishable’ cid to use for initializing Connect for client-side integration.

apiKeystringRead-only

A secure token that can be used to make M2M API calls to read data generated by this object.

namestring or null

A human readable name for the connect, optional.

activeboolean or null

A flag to indicate if this connect is active. If true, then this Connect can process donations and grants, otherwise this Connect cannot process grants.

createdAtstring or nullRead-onlyformat: "date-time"

Time when this object was created. Expressed in RFC 3339 format.

updatedAtstring or nullRead-onlyformat: "date-time"

Time when this object was last updated. Expressed in RFC 3339 format.

createdBystring or nullRead-only

ID of the user who created this object.

archivedboolean or nullRead-only

A flag to indicate if this object is marked for deletion.

metadatamap from strings to strings or null

A map of arbitrary string keys and values to store information about the object.

1	import requests
2
3	url = "https://api.givechariot.com/v1/connects"
4
5	querystring = {"nonprofit":"6af3f58e-7a80-4997-8259-770c033d7d3a","suborganization":"c00d1aa2-09ab-4e76-8461-7ac34578a70c"}
6
7	payload = {}
8	headers = {"Content-Type": "application/json"}
9
10	response = requests.post(url, json=payload, headers=headers, params=querystring)
11
12	print(response.json())

1	{
2	"id": "test_de5a2e7d-c960-4eaa-8bd2-e8d2cc5b1a55",
3	"apiKey": "test_98235982835",
4	"name": "website",
5	"active": true,
6	"createdAt": "2021-07-10 15:00:00.000",
7	"updatedAt": "2020-01-31T23:59:59Z",
8	"createdBy": "user123",
9	"metadata": {
10	"tag1": "value1"
11	}
12	}

Query parameters

Request

Response

Errors