POST /api/v1/people
Create a Person

Create a new person in your address book.

Examples

curl -i -H "Content-Type: application/json" -d '{"person":{"name":"Jeff","surname":"Star", "list_ids":["12ab8e008f0d0c8a090f9c0b"]}}' https://api.passdock.com/api/v1/people?api_token=75778a65dfdae310a107d2ef0bbd3780

Supported Formats

json

Success Response:

201 Created
              
{
  id: "5342a521434236f5e7000007",
  name: "Mark",
  surname: "Twain",
  email: "mark.twain@example.com",
  telephone: "555-123-4567",
  birthday: "1835/11/30 00:00:00",
  custom_field: "Custom Value",
  image: "http://url/of/avatar",
  list_ids: [
    "5342a53e86d256f5e7000006",
    "5342a53e86d256f5e7000016"
  ]
}

Errors

400 Bad Request
401 Unauthorized

Params

Param name Description
api_token
required

Your Passdock API key


Value: Must be String
person
required

Object that contains Person's informations


Value: Must be a Hash
person[name]
optional

Person's name


Value: Must be String
person[surname]
optional

Person's surname


Value: Must be String
person[remote_thumbnail_url]
optional

Remote image address for a person


Value: Must be String
person[list_ids]
optional

Lists the person belongs to


Value: Must be Array
person[FIELD]
optional

Other fields specified for the person


Value: Must be String