API reference · Users
Create a user
POST/v1/users
Create a user having access to the Charitips dashboard.
Requires a Bearer access token.
Body
CreateUserDtoNo field is described in the spec.
persona#stringrequiredOptional in the spec, required by the API.
CSRMARKETINGHRSALESCOMMUNICATIONPRODUCTSMBOTHERaccountId#stringrequiredUUIDpictureUrl#stringURLemail#stringrequiredemail addressfirstName#stringrequiredlastName#stringrequiredphone#stringrole#objectrequiredADMINMEMBERPAYROLL_MANAGERcampaignIds#string[]UUID
Response
200 · UserNo field is described in the spec.
userId#stringalways returnedfirstName#stringalways returnedlastName#stringalways returnedemail#stringalways returnedphone#stringpictureUrl#stringrole#Rolealways returnedADMINMEMBERPAYROLL_MANAGERpersona#PersonaCSRMARKETINGHRSALESCOMMUNICATIONPRODUCTSMBOTHERaccountId#stringcreatedAt#string (date-time)always returnedupdatedAt#string (date-time)always returned
Errors
400A field is missing, has the wrong type, or is not part of the request schema.
Every request with a body or query is validated.
{ "statusCode": 400, "message": [ "amount must not be less than 1", "property foo should not exist" ], "error": "Bad Request" }401Unauthorized
Missing, expired or invalid access token.
{ "statusCode": 401, "message": "Unauthorized" }403Account closed
{ "message": "Account closed", "code": "ACCOUNT_CLOSED" }
curl -X POST https://api.sandbox.charitips.com/v1/users \ -H "Authorization: Bearer $CHARITIPS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "persona": "CSR", "accountId": "<accountId>", "email": "jane.doe@example.com", "firstName": "Jane", "lastName": "Doe", "role": "ADMIN" }'Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.