Create multiple profiles

POST 
/profiles

Create multiple profiles

Request

application/json

Body

required

profiles

object[]

Array [

name string

The profile name.

profile_type_id uuid

The profile type id.

status string

Possible values: [Active, Inactive, On Leave, Terminated]

The profile status.

id_proofing_status string

Possible values: [pending, pass, fail]

The id proofing status of the profile.

archived boolean

Describes whether the profile is archived or not.

attributes

object

The attributes associated with the profile.

property name* string

]

Responses

200

Expected response to a valid request

application/json

Schema

Schema

profiles

object[]

Array [

id uuid

The objects ID

uid string

Possible values: >= 32 characters and <= 32 characters

The objects UID

name string

This is the name of the profile.

profile_type_id uuid

This is the ID of the profile type the profile belongs to

status string

Possible values: [Active, Inactive, On Leave, Terminated]

This is the status of the profile

id_proofing_status string

Possible values: [pending, pass, fail]

This is the ID proofing staus of the profile

created_at date-time

The date and time the profile was created

updated_at date-time

The date and time the profile was updated

attributes

object

Attributes that belong to this profile.

property name* string

]

Example (from schema)

{
  "profiles": [
    {
      "id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
      "uid": "profileUid",
      "name": "Profile Name",
      "profile_type_id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
      "status": "Active",
      "id_proofing_status": "pending",
      "created_at": "2023-11-21T14:23:54.256-05:00",
      "updated_at": "2023-11-21T14:23:54.256-05:00",
      "attributes": {
        "text_attribute_uid": "static text",
        "date_attribute_uid": "01/15/2020",
        "profile_select_attribute_uid": "Profile Name",
        "profile_search_attribute_uid": "Profile Name",
        "multiple_profile_search_attribute_uid": "Profile Name,Second Profile Name,Third Profile Name",
        "multiple_profile_select_attribute_uid": "Profile Name,Second Profile Name,Third Profile Name",
        "contributor_select_attribute_uid": "User Name ([email protected])",
        "contributor_search_attribute_uid": "User Name ([email protected])",
        "multiple_contributor_search_attribute_uid": "User Name ([email protected]),Second User Name ([email protected]),Third User Name ([email protected])",
        "owner_select_attribute_uid": "User Name ([email protected])",
        "owner_search_attribute_uid": "User Name ([email protected])",
        "dropdown_attribute_uid": "yes, no",
        "tags_attribute_uid": "yes, no",
        "checkbox_attribute_uid": "yes, no",
        "text_area_uid": "static text",
        "radio_attribute_uid": "yes, no"
      }
    }
  ]
}

400

Bad Request - unable to complete.

application/json

Schema

Schema

oneOf

InvalidJson

error

ValidationErrors

error

errors

Example (from schema)

{}

500

Internal Server Error - returned on unhandled exceptions.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "Sorry something went wrong"
}

Loading...