Create a profile​
Create a profile
application/json
Request Body required
profile object
name string
profile_type_id uuid
status string
Possible values: [Active
, Inactive
, On Leave
, Terminated
]
id_proofing_status string
Possible values: [pending
, pass
, fail
]
archived boolean
Default value: false
attributes object
property name* string
Responses
- 200
- 400
- 500
Expected response to a valid request
application/json
Schema
Example (from schema)
Schema
profile object
name string
profile_type_id uuid
status string
Possible values: [Active
, Inactive
, On Leave
, Terminated
]
id_proofing_status string
Possible values: [pending
, pass
, fail
]
created_at date-time
updated_at date-time
attributes object
property name* string
{
"profile": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"uid": "string",
"name": "string",
"profile_type_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "Active",
"id_proofing_status": "pending",
"created_at": "2023-10-02T14:52:24.314Z",
"updated_at": "2023-10-02T14:52:24.314Z",
"attributes": {
"text_attribute_uid": "static text",
"date_attribute_uid": "01/15/2020",
"profile_select_attribute_uid": "Profile Name",
"multiple_profile_select_attribute_uid": "Profile Name,Second Profile Name,Third Profile Name",
"contributor_select_attribute_uid": "User Name",
"multiple_contributor_select_attribute_uid": "User Name,Second User Name,Third User Name"
}
}
}
Bad Request - unable to complete.
application/json
Schema
Example (from schema)
Schema
oneOf
InvalidJson
ValidationErrors
error
error
errors
{}
Internal Server Error - returned on unhandled exceptions.
application/json
Schema
Example (from schema)
Schema
error
A message describing the error
{
"error": "Sorry something went wrong"
}
Loading...