Create user - Spencer Integration API

This API call will create a user on the Spencer platform.

The attribute authentication_type defines the way of authentication for the user:

SSO: use value company_account. The attribute authentication_id must be present and contain the SSO IDP's UPN of the user (usually email).

username/password: use value username_password. At least one of the following fields must be present: email, email_private, mobile, mobile_private or alias.

IMPORTANT: our endpoints return verbose error messages in their JSON return bodies. Inspect them during development / debugging.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Example

{
    "id": "test",
    "firstname": "John",
    "lastname": "Doe",
    "email": "monika+test@spencer.co",
    "preferred_language": "en-US",
    "country": "BE",
    "company_join_date": "2020-10-02T00:00:00+00:00",
    "mobile": "+31611111111",
    "email_private": "monika.anna.rodak+delighterstagtest@gmail.com",
    "company": "Spencer",
    "authentication_id": "monika+test@spencer.co",
    "date_of_birth": "1995-10-02T00:00:00+00:00",
    "authentication_type": "username_password",
    "translations": [
        {
            "locale": "da_DK",
            "sub_division": "test subdivision da update"
        },
        {
            "locale": "de_DE",
            "contract_type": "full-time",
            "department": "Design de_DE",
            "division": "Division 2 de_DE",
            "job_title": "Engineer de_DE",
            "domain": "Domain 2 de_DE",
            "region": "Gent de_DE",
            "zone": "Zone 2 de_DE"
        },
        {
            "locale": "en_US",
            "contract_type": "full-time",
            "department": "Engineering",
            "job_title": "Software engineer",
            "zone": "Test update"
        },
        {
            "locale": "es_ES",
            "contract_type": "full-time",
            "department": "Design es_ES",
            "division": "Division 2 es_ES",
            "job_title": "Engineer es_ES",
            "domain": "Domain 2 es_ES",
            "region": "Gent es_ES",
            "zone": "Zone 2 es_ES"
        },
        {
            "locale": "fr_BE",
            "contract_type": "full-time",
            "department": "Design fr_BE",
            "division": "Division 2 fr_BE",
            "job_title": "Engineer fr_BE",
            "domain": "Domain 2 fr_BE",
            "region": "Gent fr_BE",
            "zone": "Zone 2 fr_BE"
        },
        {
            "locale": "hr_HR",
            "contract_type": "full-time",
            "department": "Design hr_HR",
            "division": "Division 2 hr_HR",
            "job_title": "Engineer hr_HR",
            "domain": "Domain 2 hr_HR",
            "region": "Gent hr_HR",
            "zone": "Zone 2 hr_HR"
        },
        {
            "locale": "hu_HU",
            "contract_type": "full-time",
            "department": "Design hu_HU",
            "division": "Division 2 hu_HU",
            "job_title": "Engineer hu_HU",
            "domain": "Domain 2 hu_HU",
            "region": "Gent hu_HU",
            "zone": "Zone 2 hu_HU"
        },
        {
            "locale": "it_IT",
            "contract_type": "full-time",
            "department": "Design it_IT",
            "division": "Division 2 it_IT",
            "job_title": "Engineer it_IT",
            "domain": "Domain 2 it_IT",
            "region": "Gent it_IT",
            "zone": "Zone 2 it_IT"
        },
        {
            "locale": "mr_IN",
            "contract_type": "full-time",
            "department": "Design mr_IN",
            "division": "Division 2 mr_IN",
            "job_title": "Engineer mr_IN",
            "domain": "Domain 2 mr_IN",
            "region": "Gent mr_IN",
            "zone": "Zone 2 mr_IN"
        },
        {
            "locale": "nb_NO",
            "contract_type": "full-time",
            "department": "Design nb_NO",
            "division": "Division 2 nb_NO",
            "job_title": "Engineer nb_NO",
            "domain": "Domain 2 nb_NO",
            "region": "Gent nb_NO",
            "zone": "Zone 2 nb_NO"
        },
        {
            "locale": "nl_BE",
            "contract_type": "full-time",
            "department": "Design nl_BE",
            "division": "Division 2 nl_BE",
            "job_title": "Engineer nl_BE",
            "domain": "Domain 2 nl_BE",
            "region": "Gent nl_BE",
            "zone": "Zone 2 nl_BE update"
        },
        {
            "locale": "pl_PL",
            "contract_type": "full-time",
            "department": "Design pl_PL",
            "division": "Division 2 pl_PL",
            "job_title": "Engineer pl_PL",
            "domain": "Domain 2 pl_PL",
            "region": "Gent pl_PL",
            "zone": "Zone 2 pl_PL"
        },
        {
            "locale": "ro_RO",
            "contract_type": "full-time",
            "department": "Design ro_RO",
            "division": "Division 2 ro_RO",
            "job_title": "Engineer ro_RO",
            "domain": "Domain 2 ro_RO",
            "region": "Gent ro_RO",
            "zone": "Zone 2 ro_RO"
        },
        {
            "locale": "sl_SI",
            "contract_type": "full-time",
            "department": "Design sl_SI",
            "division": "Division 2 sl_SI",
            "job_title": "Engineer sl_SI",
            "domain": "Domain 2 sl_SI",
            "region": "Gent sl_SI",
            "zone": "Zone 2 sl_SI"
        },
        {
            "locale": "tr_TR",
            "contract_type": "full-time",
            "department": "Design tr_TR",
            "division": "Division 2 tr_TR",
            "job_title": "Engineer tr_TR",
            "domain": "Domain 2 tr_TR",
            "region": "Gent tr_TR",
            "zone": "Zone 2 tr_TR"
        },
        {
            "locale": "zh_CN",
            "contract_type": "full-time",
            "department": "Design zh_CN",
            "division": "Division 2 zh_CN",
            "job_title": "Engineer zh_CN",
            "domain": "Domain 2 zh_CN",
            "region": "Gent zh_CN",
            "zone": "Zone 2 zh_CN"
        }
    ],
    "user_identifiers": [],
    "tags": ["Tasks"],
    "default_site_id": "1234",
    "employeeType": "Salaried",
    "employeeClass": "T",
    "normalizedGrade": 15
}

Request Code Samples

Shell

HTTP

curl --location '/agent/integration/api/v1/users/users' \
--header 'x-spencer-request-id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "test",
    "firstname": "John",
    "lastname": "Doe",
    "email": "monika+test@spencer.co",
    "preferred_language": "en-US",
    "country": "BE",
    "company_join_date": "2020-10-02T00:00:00+00:00",
    "mobile": "+31611111111",
    "email_private": "monika.anna.rodak+delighterstagtest@gmail.com",
    "company": "Spencer",
    "authentication_id": "monika+test@spencer.co",
    "date_of_birth": "1995-10-02T00:00:00+00:00",
    "authentication_type": "username_password",
    "translations": [
        {
            "locale": "da_DK",
            "sub_division": "test subdivision da update"
        },
        {
            "locale": "de_DE",
            "contract_type": "full-time",
            "department": "Design de_DE",
            "division": "Division 2 de_DE",
            "job_title": "Engineer de_DE",
            "domain": "Domain 2 de_DE",
            "region": "Gent de_DE",
            "zone": "Zone 2 de_DE"
        },
        {
            "locale": "en_US",
            "contract_type": "full-time",
            "department": "Engineering",
            "job_title": "Software engineer",
            "zone": "Test update"
        },
        {
            "locale": "es_ES",
            "contract_type": "full-time",
            "department": "Design es_ES",
            "division": "Division 2 es_ES",
            "job_title": "Engineer es_ES",
            "domain": "Domain 2 es_ES",
            "region": "Gent es_ES",
            "zone": "Zone 2 es_ES"
        },
        {
            "locale": "fr_BE",
            "contract_type": "full-time",
            "department": "Design fr_BE",
            "division": "Division 2 fr_BE",
            "job_title": "Engineer fr_BE",
            "domain": "Domain 2 fr_BE",
            "region": "Gent fr_BE",
            "zone": "Zone 2 fr_BE"
        },
        {
            "locale": "hr_HR",
            "contract_type": "full-time",
            "department": "Design hr_HR",
            "division": "Division 2 hr_HR",
            "job_title": "Engineer hr_HR",
            "domain": "Domain 2 hr_HR",
            "region": "Gent hr_HR",
            "zone": "Zone 2 hr_HR"
        },
        {
            "locale": "hu_HU",
            "contract_type": "full-time",
            "department": "Design hu_HU",
            "division": "Division 2 hu_HU",
            "job_title": "Engineer hu_HU",
            "domain": "Domain 2 hu_HU",
            "region": "Gent hu_HU",
            "zone": "Zone 2 hu_HU"
        },
        {
            "locale": "it_IT",
            "contract_type": "full-time",
            "department": "Design it_IT",
            "division": "Division 2 it_IT",
            "job_title": "Engineer it_IT",
            "domain": "Domain 2 it_IT",
            "region": "Gent it_IT",
            "zone": "Zone 2 it_IT"
        },
        {
            "locale": "mr_IN",
            "contract_type": "full-time",
            "department": "Design mr_IN",
            "division": "Division 2 mr_IN",
            "job_title": "Engineer mr_IN",
            "domain": "Domain 2 mr_IN",
            "region": "Gent mr_IN",
            "zone": "Zone 2 mr_IN"
        },
        {
            "locale": "nb_NO",
            "contract_type": "full-time",
            "department": "Design nb_NO",
            "division": "Division 2 nb_NO",
            "job_title": "Engineer nb_NO",
            "domain": "Domain 2 nb_NO",
            "region": "Gent nb_NO",
            "zone": "Zone 2 nb_NO"
        },
        {
            "locale": "nl_BE",
            "contract_type": "full-time",
            "department": "Design nl_BE",
            "division": "Division 2 nl_BE",
            "job_title": "Engineer nl_BE",
            "domain": "Domain 2 nl_BE",
            "region": "Gent nl_BE",
            "zone": "Zone 2 nl_BE update"
        },
        {
            "locale": "pl_PL",
            "contract_type": "full-time",
            "department": "Design pl_PL",
            "division": "Division 2 pl_PL",
            "job_title": "Engineer pl_PL",
            "domain": "Domain 2 pl_PL",
            "region": "Gent pl_PL",
            "zone": "Zone 2 pl_PL"
        },
        {
            "locale": "ro_RO",
            "contract_type": "full-time",
            "department": "Design ro_RO",
            "division": "Division 2 ro_RO",
            "job_title": "Engineer ro_RO",
            "domain": "Domain 2 ro_RO",
            "region": "Gent ro_RO",
            "zone": "Zone 2 ro_RO"
        },
        {
            "locale": "sl_SI",
            "contract_type": "full-time",
            "department": "Design sl_SI",
            "division": "Division 2 sl_SI",
            "job_title": "Engineer sl_SI",
            "domain": "Domain 2 sl_SI",
            "region": "Gent sl_SI",
            "zone": "Zone 2 sl_SI"
        },
        {
            "locale": "tr_TR",
            "contract_type": "full-time",
            "department": "Design tr_TR",
            "division": "Division 2 tr_TR",
            "job_title": "Engineer tr_TR",
            "domain": "Domain 2 tr_TR",
            "region": "Gent tr_TR",
            "zone": "Zone 2 tr_TR"
        },
        {
            "locale": "zh_CN",
            "contract_type": "full-time",
            "department": "Design zh_CN",
            "division": "Division 2 zh_CN",
            "job_title": "Engineer zh_CN",
            "domain": "Domain 2 zh_CN",
            "region": "Gent zh_CN",
            "zone": "Zone 2 zh_CN"
        }
    ],
    "user_identifiers": [],
    "tags": ["Tasks"],
    "default_site_id": "1234",
    "employeeType": "Salaried",
    "employeeClass": "T",
    "normalizedGrade": 15
}'

Responses

🟢201201.user

application/json

Headers

Bodyapplication/json

Example

{"id":"12345","firstname":"pariatur elit Lorem nulla","lastname":"incididunt ","email":"nulla aliqua","manager_id":"12345","preferred_language":"ut","country":"veniam","company_join_date":"2015-10-06T11:42:06.733Z","phone_private":"culpa","mobile":"Duis Ut enim","email_private":"","workstation":"et adipisicing","subsidiary":"occaecat nulla voluptate adipisicing","company":"magna occaecat nostrud","date_of_birth":"2001-07-29T01:05:54.413Z","translations":[{"locale":"Lorem dolor pariatur mag","contract_type":"irure","department":"exercitation nulla aute magna","division":"laboris","sub_division":"aliquip aliqua exercitation fugiat","job_title":"proident amet non esse dolore","domain":"dolor ipsum","region":"mollit","zone":"p"},{"locale":"dolor et tem","contract_type":"in aliquip ipsum minim","department":"eiusmod cillum non","division":"proident irure elit enim sit","sub_division":"nisi enim et","job_title":"dolor ipsum qui officia veniam","domain":"est elit","region":"Duis exercitation in","zone":"laboris irure"},{"locale":"ad culpa","contract_type":"sint ex","department":"consectetur","division":"proident dolore eu aliqua","sub_division":"ipsum et tempor","job_title":"sit","domain":"ad voluptate veniam dolore et","region":"ea","zone":"ad laboris"},{"locale":"ea","contract_type":"ullamco Lorem esse nostrud Ut","department":"minim ut","division":"eiusmod in sed minim et","sub_division":"commodo ad sed","job_title":"eiusmod mollit qui","domain":"aliquip","region":"magna Ut ipsum","zone":"laborum Lorem voluptate ad"},{"locale":"minim Ut exercitation laborum","contract_type":"consequat irure exercitation","department":"aliqua Excepteur cillum adipisicing","division":"culpa incididunt commodo reprehenderit ut","sub_division":"sunt adipisicing Lorem pariatur consectetur","job_title":"proident","domain":"","region":"eu in","zone":"nulla"}]}

🟠400400.badRequest

🟠401401.unauthorized

🟠403403.forbidden

🟠404404.notFound

🟠409409.conflict

🔴500500.internalServerError