DAFpayConnects

Create Connect

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 using the connect_id query parameter in any of the List Grants API endpoints.

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

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
organization_idstringRequired
The unique identifier for the organization
contactobjectRequired
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

OK
idstring

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

apiKeystring

(deprecated) 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.
createdAtdatetime or null
Time when this object was created. Expressed in RFC 3339 format.
updatedAtdatetime or null
Time when this object was last updated. Expressed in RFC 3339 format.
createdBystring or null
ID of the user who created this object.
archivedboolean or null
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.

Errors