Skip to main content

POST Organization User

Overview


The following table contains important information about the POST method in regards to posting an organization.

POST Organization
MethodPOST
URL or Endpoint/api/organizations/users
ParametersNone
BodyCheck request body below

Request Body

{
"user": {
"publicId": "string",
"email": "string"
},
"organizationId": "string"
}

Information about the fields that appear when you receive the response are displayed in the table below.

Parameter NameMandatoryTypeDescription
userYesObjectRepresents the user as an object.
publicIdYesstringThe public ID of the user.
emailYesstringThe email of the user.
organizationIdYesstringThe ID of the organization you want to add the user to.

Response

{
"success": true,
"errors": ["string"],
"messages": ["User added successfully!"],
"result": {},
"resultInfo": "string",
"statusCode": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false
errorsarray[string]Indicates if there was an error
messagesarray[string]Returns the response message from back-end
resultarray[Object]Returns the response object
resultInfostringReturns extra information about the result
statusCodeinteger($int32)Returns the HTTP Status Code

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed