Apis::V4::People API

post a new person

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 into the new person
included List of new models to be created as related to new person.
Note on contact assignments: to specify what direction the assignment goes, the client must use either the assigned_to_id or person_id field. The omitted field will be set as the newly-created person's id. But they both will use the contact_assignment type.
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.eyJ1c2VyX2lkIjoxNiwiZXhwIjoxNzA0NDczMjIyLCJpYXQiOjE3MDQ0NzMwNDJ9.x6IQXSi7pVF2hfM6pXH1c-4KwjeySvSB6NzyC1-Xq-s
Host: example.org
Cookie: 

Route

POST /apis/v4/people

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.eyJ1c2VyX2lkIjoxNiwiZXhwIjoxNzA0NjQ1ODQyLCJpYXQiOjE3MDQ0NzMwNDJ9.sRUgeJMXWzi5cF3XStEP_Gj45qqkpCRodO0kmpbsGZc
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"be3bbb302f7f848aecc360a0afa5b3e6"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 048b85db-f974-4b37-b9d3-66df65f61d30
X-Runtime: 0.156819
Content-Length: 2187

Status

201

Body