Apis::V4::People API

send note as included

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 be serialized update the person
included List of new models or changes on existing models to be associated to the person.
include comma delimited relationships you want included in the response in snake_case format
fields A comma separated list of fields to return in the response for the given type. A resource object's attributes and its relationships are collectively called its 'fields'. Clients may restrict the set of fields in order to improve performance. Multiple types can be specified. If no fields param is specified then by default all fields are returned. Example

Request

Headers

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

Route

PUT /apis/v4/people/21

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.eyJ1c2VyX2lkIjoxNiwiZXhwIjoxNzA0NjQ1ODQwLCJpYXQiOjE3MDQ0NzMwNDB9.5n1yCvFxsLOizUYqG4eC-8r3CSIFTzzYSv1E-SYnHEY
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"58b24f725d5b90ef42c46113e1e34603"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 45131849-feeb-4a77-8149-b7d1669739cb
X-Runtime: 0.135085
Content-Length: 937

Status

200

Body