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.

Query parameters

nonprofitstringRequired

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

suborganizationstringOptional

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

Request

This endpoint expects an object.

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

This endpoint returns an object.

idstring

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

apiKeystring

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

namestringOptional

A human readable name for the connect, optional.

activebooleanOptional

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.

createdAtdatetimeOptional

Time when this object was created. Expressed in ISO 8601 format.

updatedAtdatetimeOptional

Time when this object was last updated. Expressed in ISO 8601 format.

createdBystringOptional

ID of the user who created this object.

archivedbooleanOptional

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