v1

latestOpenAPI 3.0.02026-08-062903562.2 MB

Organization Consumer Mappings

Set a mapping as the primary for its consumer charity ID

Switch the primary mapping for a consumer charity ID

post/consumer-charity-mappings/{id}/set-primary

Path parameters

idinteger required

Mapping ID to set as primary

Response

Primary mapping switched successfully

idinteger

Primary identifier of record

organization_idinteger nullable

Internal organization ID (null if unmatched)

consumer_charity_idinteger

External consumer charity ID

einstring

EIN without dashes (9 digits)

is_primaryboolean

Whether this is the primary organization for this consumer charity ID

is_matchedboolean

Whether this mapping is matched to an organization (true if organization_id is not null)

created_atstring date-time

Date/time of record creation

updated_atstring date-time

Date/time of record last update

Example response

{
  "id": 1,
  "organization_id": 123,
  "consumer_charity_id": 456789,
  "ein": "123456789",
  "is_primary": true,
  "is_matched": true,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}