Apis::V4::BulkPeopleChanges API

changes two people

Parameters

Name Description
access_token JSON Web Token retrieved from the Sessions endpoint (you can also pass this into the Authorization header)
data The payload data that will define the bulk person update. Attribute fields with example values:
- person_ids = 3,4 (required, people you are updated)
- organization_id = 3 (required if changing archived, delete, permission_id, followup_status, assigned_to_id)
- gender = Male
- archived = true/false (true will archive all people, false will un-archive them. chances all scoped to organization_id)
- delete = true (will delete people from organization)
- permission_id = 1 (change permission of people on organization)
- followup_status = contacted (change status on organization)
- assigned_tos = { 1: true, 5: false } (hash of person ids and true/false. true values will assign all people to that leader, false will remove all assignments for that person id and organization)
filters comma delimited filters. you can use any of the ones found on the people list request but you may only list one id in organization_ids as you can only make bulk updates to one organization at a time.

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNDEsImV4cCI6MTcwNDQ3MzIzMiwiaWF0IjoxNzA0NDczMDUyfQ.F4xlmaIj2wxFByXLtHSKSM3D8JAJ5gXw_teNG9a7_MM
Host: example.org
Cookie: 

Route

POST /apis/v4/bulk_people_changes/

Body

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
X-MH-Session: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNDEsImV4cCI6MTcwNDY0NTg1MiwiaWF0IjoxNzA0NDczMDUyfQ.LjPL9hoCPo7r3wNwjNgdoYXvx-s_uSTjL6iMm9BWTVs
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"87158cee885b7ea673cf940ae1ce3506"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 132408c3-20be-48ac-a308-9384f01b51b8
X-Runtime: 0.037595
Content-Length: 164

Status

200

Body