Create a profile​
Create a profile
- application/json
Request Body required
profile object
name stringThe name
profile_type_id uuidthe profile type id
status stringPossible values: [
Active
,Inactive
,On Leave
,Terminated
]the status
id_proofing_status stringPossible values: [
pending
,pass
,fail
]the id proofing status
archived booleanDefault value:
false
is this profile archived
attributes object
the attributes
property name*
string
Responses
- 200
- 400
- 500
Expected response to a valid request
- application/json
- Schema
- Example (from schema)
Schema
profile object
id uuidthe id
uid stringPossible values:
>= 32 characters
and<= 32 characters
the uid
name stringthe name
profile_type_id uuidThe profile type id
status stringPossible values: [
Active
,Inactive
,On Leave
,Terminated
]the status
id_proofing_status stringPossible values: [
pending
,pass
,fail
]the id profing status
created_at date-timethe created at time
updated_at date-timethe updated at time
attributes object
the attributes
property name*
string
{
"profile": {
"id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"uid": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"name": "my profile",
"profile_type_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
"status": "Active",
"id_proofing_status": "pending",
"created_at": "2023-05-01T09:12:28Z",
"updated_at": "2023-05-01T09:12:28Z",
"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
- MOD1
- MOD2
- error
- error
- errors
oneOf
{
"error": "Invalid JSON syntax. Please check your syntax and try again."
}
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...