people/create

Create a new person.

POST https://api.elvanto.com/v1/people/create.{json|xml|php}

Parameters

Name Type Description
firstname Required string The First Name of the person.
preferred_name string The preferred name for the person (their nick name for example).
lastname Required string The Last Name of the person.
email string The Email Address of the person.
phone string The Phone Number of the person. Everything but numbers will be stripped and the number will be formatted in your account according to your settings.
mobile string The Mobile Number of the person. Everything but numbers will be stripped and the number will be formatted in your account according to your settings.
category_id string The ID of the People Category you would like to add this person to. If this parameter is not used or left empty, the category_id will be set to the default People Category in your settings.
archived string Would you like to make this person archived? This can be yes or no. Defaults to no.
contact string Would you like to make this person a contact? This can be yes or no. Defaults to no.
volunteer string Would you like to make this person a volunteer? This can be yes or no. Defaults to no.
status string Only applies if this person has a username and password. This can be active or suspended. Defaults to active.
username string A username for this person.
password string A password for this person. Will generate a random password if username if filled and password is left blank.
family_id integer Sets the Family ID for this person. If the Family ID is already assigned to another person, the person created will be added to the existing family. Setting the value of this field to new will create a brand new family.
family_relationship string Sets the Family Relationship for this person.
Accepted Values: Primary Contact, Spouse, Partner, Child, Sibling, Grandfather, Grandmother, Other
fields array The extra fields you would like to add to the person. More information on people fields.
Expected request JSON HTTP POST
{
    "firstname": "John",
    "preferred_name": "Jonny",
    "lastname": "Smith",
    "category_id": "8a631195-8914-4136-858c-f160885ab60d",
    "email": "john@johnsmith.com",
    "phone": "999-999-999",
    "mobile": "888-888-888",
    "volunteer": "Yes",
    "username": "john.smith",
    "password": "john9876",
    "family_id": "38",
    "family_relationship": "Primary Contact",
    "fields": {
        "gender": "Male",
        "birthday": "1989-04-23",
        "anniversary": "2012-03-24",
        "marital_status": "Married",
        "access_permissions": [
            "Leaders"
        ]
    }
}
Expected response JSON XML PHP
{
    "generated_in": "0.018",
    "status": "ok",
    "person": {
        "id": "7bcb4c7e-1008-11e3-b25c-fb2ff5416432",
        "family_id": 38
    }
}
Error responses:

Please see our response status codes documentation for details of potential error responses for any API request.

  • 404: Invalid People Category ID The People Category ID you provided does not exist.