Appeals

Appeals Documentation

Appeal [LIST]

Appeal [LIST]

Request

Endpoint

GET /api/v2/appeals
Content-Type: application/vnd.api+json

Body

Parameters

Filters

account_list_id

Type ID string

Description Filter by Account List; accepts an Account List id; this is required if you want the Contact included on Donations.

Required No

appeal_id

Type ID string

Description where appeal_id

Required No

wildcard_search

Type string

Description where name contains or designation_number starts with wildcard_search

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "a876f5a0-d008-46bb-b376-dad20c4f85b3",
      "type": "appeals",
      "attributes": {
        "amount": "1000.0",
        "created_at": "2022-01-12T17:18:49Z",
        "currencies": [
          "ZAR"
        ],
        "description": "The description for my new Appeal",
        "end_date": "2022-01-19",
        "name": "Appeal #22",
        "pledges_amount_not_received_not_processed": 0,
        "pledges_amount_processed": 0,
        "pledges_amount_received_not_processed": 0,
        "pledges_amount_total": 0,
        "total_currency": "USD",
        "updated_at": "2022-01-12T17:18:49Z",
        "updated_in_db_at": "2022-01-12T17:18:49Z"
      },
      "relationships": {
        "account_list": {
          "data": {
            "id": "1a740076-f67e-4c01-ac64-6e47a1ad7e01",
            "type": "account_lists"
          }
        },
        "contacts": {
          "data": [

          ]
        },
        "donations": {
          "data": [
            {
              "id": "70704e7b-1fcf-48ab-9edd-1a014210a3df",
              "type": "donations"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Appeal]

Description An array of Appeal Objects

Appeal [POST]

Appeal [POST]

Request

Endpoint

POST /api/v2/appeals
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "appeals",
    "attributes": {
      "amount": 1000.0,
      "description": "The description for my new Appeal",
      "end_date": "2022-01-19",
      "exclusion_filter": {
        "status": "Partner - Financial"
      },
      "inclusion_filter": {
        "status": "Partner - Financial,Partner - Pray"
      },
      "name": "Appeal #24",
      "updated_in_db_at": "2022-01-12 17:18:50 UTC"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "13906c51-76a8-4cc7-9575-13d4894f0ba3"
        }
      }
    }
  }
}

Parameters

Attributes

amount

Type float

Description The amount requested for this Appeal

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

description

Type string

Description The description for this Appeal

Required No

end_date

Type date string

Description The date in which this Appeal ends

Required No

exclusion_filter

Type object

Description A contact filter object which will specify which contacts to exclude by default

Required No

inclusion_filter

Type object

Description A contact filter object which will specify which contacts to include by default

Required No

name

Type string

Description The name of the Appeal

Required No

pledges_amount_not_received_not_processed

Type number

Description total of pledges where they have not been received

Required No

pledges_amount_processed

Type number

Description total of pledges where they have been processed

Required No

pledges_amount_received_not_processed

Type number

Description total of pledges where they have been received but not yet processed

Required No

pledges_amount_total

Type number

Description total of pledges

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Relationships

account_list.data

Type Account List

Description The account list that this Appeal belongs to

Required No

donations.data

Type [Donation]

Description An array of Donation references for the Appeal

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

Body

{
  "data": {
    "id": "fa998b55-78ef-4e92-b604-5c50fce86c7c",
    "type": "appeals",
    "attributes": {
      "amount": "1000.0",
      "created_at": "2022-01-12T17:18:50Z",
      "currencies": [

      ],
      "description": "The description for my new Appeal",
      "end_date": "2022-01-19",
      "name": "Appeal #24",
      "pledges_amount_not_received_not_processed": 0,
      "pledges_amount_processed": 0,
      "pledges_amount_received_not_processed": 0,
      "pledges_amount_total": 0,
      "total_currency": "USD",
      "updated_at": "2022-01-12T17:18:50Z",
      "updated_in_db_at": "2022-01-12T17:18:50Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "13906c51-76a8-4cc7-9575-13d4894f0ba3",
          "type": "account_lists"
        }
      },
      "contacts": {
        "data": [
          {
            "id": "85a25d9d-88a8-4c8c-b5c3-edb32687bb15",
            "type": "contacts"
          }
        ]
      },
      "donations": {
        "data": [

        ]
      }
    }
  }
}

Fields

Attributes

amount

Type float

Description The amount requested for this Appeal

created_at

Type date

Description The timestamp of when this resource was created

currencies

Type [string]

Description The currencies of the donations for this Appeal

description

Type string

Description The description for this Appeal

end_date

Type date string

Description The date in which this Appeal ends

name

Type string

Description The name of the Appeal

pledges_amount_not_received_not_processed

Type number

Description total of pledges where they have not been received

pledges_amount_processed

Type number

Description total of pledges where they have been processed

pledges_amount_received_not_processed

Type number

Description total of pledges where they have been received but not yet processed

pledges_amount_total

Type number

Description total of pledges

total_currency

Type string

Description The type of currency for the Appeal's donations to be converted to

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

account_list.data

Type Account List

Description The account list that this Appeal belongs to

contacts.data

Type [Contact]

Description An array of Contact references for the Appeal

donations.data

Type [Donation]

Description An array of Donation references for the Appeal

Appeal [GET]

Appeal [GET]

Request

Endpoint

GET /api/v2/appeals/ab69350e-74e8-4178-bb89-fcd05fd7652a
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "ab69350e-74e8-4178-bb89-fcd05fd7652a",
    "type": "appeals",
    "attributes": {
      "amount": "1000.0",
      "created_at": "2022-01-12T17:18:49Z",
      "currencies": [
        "ZAR"
      ],
      "description": "The description for my new Appeal",
      "end_date": "2022-01-19",
      "name": "Appeal #18",
      "pledges_amount_not_received_not_processed": 0,
      "pledges_amount_processed": 0,
      "pledges_amount_received_not_processed": 0,
      "pledges_amount_total": 0,
      "total_currency": "USD",
      "updated_at": "2022-01-12T17:18:49Z",
      "updated_in_db_at": "2022-01-12T17:18:49Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "39f85f98-d23f-40af-b78e-ffc1b69691da",
          "type": "account_lists"
        }
      },
      "contacts": {
        "data": [

        ]
      },
      "donations": {
        "data": [
          {
            "id": "f35f80cd-f7d7-42ac-9f74-aca575cf1bb6",
            "type": "donations"
          }
        ]
      }
    }
  }
}

Fields

Attributes

amount

Type float

Description The amount requested for this Appeal

created_at

Type date

Description The timestamp of when this resource was created

currencies

Type [string]

Description The currencies of the donations for this Appeal

description

Type string

Description The description for this Appeal

end_date

Type date string

Description The date in which this Appeal ends

name

Type string

Description The name of the Appeal

pledges_amount_not_received_not_processed

Type number

Description total of pledges where they have not been received

pledges_amount_processed

Type number

Description total of pledges where they have been processed

pledges_amount_received_not_processed

Type number

Description total of pledges where they have been received but not yet processed

pledges_amount_total

Type number

Description total of pledges

total_currency

Type string

Description The type of currency for the Appeal's donations to be converted to

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

account_list.data

Type Account List

Description The account list that this Appeal belongs to

contacts.data

Type [Contact]

Description An array of Contact references for the Appeal

donations.data

Type [Donation]

Description An array of Donation references for the Appeal

Appeal [PUT]

Appeal [PUT]

Request

Endpoint

PUT /api/v2/appeals/ce6af645-2382-4697-8a85-409c0f4e5969
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "appeals",
    "attributes": {
      "amount": 1000.0,
      "description": "The description for my new Appeal",
      "end_date": "2022-01-19",
      "exclusion_filter": {
        "status": "Partner - Financial"
      },
      "inclusion_filter": {
        "status": "Partner - Financial,Partner - Pray"
      },
      "name": "Appeal #21",
      "updated_in_db_at": "2022-01-12 17:18:49 UTC"
    },
    "relationships": {
      "account_list": {
        "data": {
          "type": "account_lists",
          "id": "f3c5daa4-827a-44c1-9cbf-dee5d4a58bc9"
        }
      }
    }
  }
}

Parameters

Attributes

amount

Type float

Description The amount requested for this Appeal

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

description

Type string

Description The description for this Appeal

Required No

end_date

Type date string

Description The date in which this Appeal ends

Required No

exclusion_filter

Type object

Description A contact filter object which will specify which contacts to exclude by default

Required No

inclusion_filter

Type object

Description A contact filter object which will specify which contacts to include by default

Required No

name

Type string

Description The name of the Appeal

Required No

overwrite

Type boolean

Description Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.

Required No

pledges_amount_not_received_not_processed

Type number

Description total of pledges where they have not been received

Required No

pledges_amount_processed

Type number

Description total of pledges where they have been processed

Required No

pledges_amount_received_not_processed

Type number

Description total of pledges where they have been received but not yet processed

Required No

pledges_amount_total

Type number

Description total of pledges

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Relationships

account_list.data

Type Account List

Description The account list that this Appeal belongs to

Required No

donations.data

Type [Donation]

Description An array of Donation references for the Appeal

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "ce6af645-2382-4697-8a85-409c0f4e5969",
    "type": "appeals",
    "attributes": {
      "amount": "1000.0",
      "created_at": "2022-01-12T17:18:49Z",
      "currencies": [
        "ZAR"
      ],
      "description": "The description for my new Appeal",
      "end_date": "2022-01-19",
      "name": "Appeal #21",
      "pledges_amount_not_received_not_processed": 0,
      "pledges_amount_processed": 0,
      "pledges_amount_received_not_processed": 0,
      "pledges_amount_total": 0,
      "total_currency": "USD",
      "updated_at": "2022-01-12T17:18:49Z",
      "updated_in_db_at": "2022-01-12T17:18:49Z"
    },
    "relationships": {
      "account_list": {
        "data": {
          "id": "f3c5daa4-827a-44c1-9cbf-dee5d4a58bc9",
          "type": "account_lists"
        }
      },
      "contacts": {
        "data": [

        ]
      },
      "donations": {
        "data": [
          {
            "id": "e13a3d4e-76b9-4a37-bdce-2dbe65ee276f",
            "type": "donations"
          }
        ]
      }
    }
  }
}

Fields

Attributes

amount

Type float

Description The amount requested for this Appeal

created_at

Type date

Description The timestamp of when this resource was created

currencies

Type [string]

Description The currencies of the donations for this Appeal

description

Type string

Description The description for this Appeal

end_date

Type date string

Description The date in which this Appeal ends

name

Type string

Description The name of the Appeal

pledges_amount_not_received_not_processed

Type number

Description total of pledges where they have not been received

pledges_amount_processed

Type number

Description total of pledges where they have been processed

pledges_amount_received_not_processed

Type number

Description total of pledges where they have been received but not yet processed

pledges_amount_total

Type number

Description total of pledges

total_currency

Type string

Description The type of currency for the Appeal's donations to be converted to

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Relationships

account_list.data

Type Account List

Description The account list that this Appeal belongs to

contacts.data

Type [Contact]

Description An array of Contact references for the Appeal

donations.data

Type [Donation]

Description An array of Donation references for the Appeal

Appeal [DELETE]

Appeal [DELETE]

Request

Endpoint

DELETE /api/v2/appeals/0c8d7cb9-d259-48d0-b520-b3aa57df3691
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body