Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

...

Beneficiaries (aka contacts)

Desc: Get all viewable contact details

Latest changes: now includes avatar and custom fields

url: /beneficiaries

params: default params
header: {'X-User-Token': 'Ppteex1dWbEcnNC311NFOrJqNHP98zN2ccMpWEei--ixL50J7uZsnprbOu--WbOcz50zaS48JzyXXZHS9A==',
'X-User-Email': ‘soft.dave99@gmail.com’}

...

response example: default response example (multiple records)

...

 

Desc: Get a single contact

Latest changes: now includes avatar and custom fields

url: /beneficiaries/:id

header: {'X-User-Token': 'Ppteex1dWbEcnNC311NFOrJqNHP98zN2ccMpWEei--ixL50J7uZsnprbOu--WbOcz50zaS48JzyXXZHS9A==',
'X-User-Email': ‘soft.dave99@gmail.com’}

params {id: 1245}

response example: default response example (single record)

...

 

Desc: Post a single contact

url: /beneficiaries

method: POST

...

body:{ "beneficiary": { "name": "Jack", "date_of_birth": "13-05-1899", "address": "Paris", "latitude": "48.856613", "longitude": "2.352222", "beneficiary_type_id": 1, "owner_id": 237 }, "project_ids": [572], "custom_fields": {"173": "3256895684"}, "beneficiary_category_ids": [294] }

header: {'X-User-Token': 'Ppteex1dWbEcnNC311NFOrJqNHP98zN2ccMpWEei--ixL50J7uZsnprbOu--WbOcz50zaS48JzyXXZHS9A==',
'X-User-Email': ‘soft.dave99@gmail.com’}

response example: default response example (single record)

...

 

Desc: Get all advanced custom fields

url: beneficiaries/advanced_custom_fields

...

response example: default response example (multiple records)

 

Desc: Get all impact box data

url: /beneficiaries/impact_box_data

...