Update an entity

PATCH

https://ssuccessv2.com/app/api/v1/entity/update/:id

PATCH

/app/api/v1/entity/update/:id

$ curl -X PATCH https://ssuccessv2.com/app/api/v1/entity/update/91 \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "entity_type_id": 4,
>   "name": "Rivera Family Foundation",
>   "tax_exempt": true,
>   "email": "finance@riverafoundation.org"
> }'

1 {
2   "status": "success",
3   "message": "Entity updated.",
4   "data": {
5     "id": 91,
6     "name": "Rivera Family Foundation",
7     "legal_name": "Rivera Family Foundation Inc.",
8     "tax_id": "11-2345678",
9     "tax_exempt": true,
10     "email": "finance@riverafoundation.org",
11     "phone": "+1-212-555-0160",
12     "note": "Updated sponsor note",
13     "type": null,
14     "addresses": null,
15     "total_paid": null,
16     "total_fees": null,
17     "total_due_today": null,
18     "donation_receipt_not_allowed": false,
19     "processing_fee_blocked": false,
20     "is_processing_fee_blocked": false
21   }
22 }

Updates an entity and, when supplied, creates or updates its address.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

idintegerRequired

Entity ID.

Request

This endpoint expects an object.

entity_type_idintegerRequired

namestringRequired<=255 characters

legal_namestring or nullOptional<=255 characters

tax_idstring or nullOptional<=50 characters

tax_exemptboolean or nullOptional

emailstring or nullOptionalformat: "email"<=255 characters

phonestring or nullOptional<=50 characters

notestring or nullOptional

addresslist of maps from strings to any or nullOptional

donation_receipt_not_allowedboolean or nullOptional

processing_fee_blockedboolean or nullOptional

Response

Entity updated.

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error