Skip to main content

Update a profile type by id

PATCH 

/profile_types/:id

Update a profile type by id

Request

Path Parameters

    id uuidrequired

    ID of the object to retrieve, update, or delete

Body

required
    profile_type object
    name string

    This is the name of the profile type.

    category string

    Possible values: [employee, non-employee, organization, assignment, other]

    This is the category the profile type falls into.

    bypass_dup_protection boolean

    Whether or not duplication protection is bypassed.

    archived boolean

    Whether or not the profile type is archived.

    permitted_role_ids uuid[]

    The role ids that are permitted for this profile type.

    isc_synced boolean

    Default value: false

    Is this profile type synced with ics

    profile_type_dup_attributes_attributes object[]
  • Array [
  • ne_attribute_id uuid

    The ID of the ne attribute.

  • ]
  • profile_type_namings_attributes object[]
  • Array [
  • ne_attribute_id uuid

    The ID of the associated ne attribute.

    order integer

    The order that the namings are used in.

  • ]

Responses

Expected response to a valid request

Schema
    profile_type object
    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 type.

    category string

    Possible values: [employee, non-employee, organization, assignment, other]

    This is the category the profile type falls into.

    bypass_dup_protection boolean

    Whether or not duplication protection is bypassed.

    archived boolean

    Whether or not the profile type is archived.

    permitted_role_ids uuid[]

    The role ids that are permitted for this profile type.

    isc_synced boolean

    Is this profile type synced with ics

    profile_type_dup_attributes object[]
  • Array [
  • id uuid

    The ID of the properties that are used for duplication protection.

    uid string

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

    The uid of the properties that are used for duplication protection.

    profile_type_id uuid

    The ID of the profile type.

    ne_attribute_id uuid

    The ID of the ne attribute.

  • ]
  • profile_type_namings object[]
  • Array [
  • id uuid

    The ID of the profile type naming.

    uid string

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

    The UID of the profile type naming.

    profile_type_id uuid

    The ID of the associated profile type.

    ne_attribute_id uuid

    The ID of the associated ne attribute.

    order integer

    The order that the namings are used in.

  • ]
Loading...