Update Profile Photo

Request

Update the profile photo for the specified user.

This endpoint returns structured User objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the users top-level JSON key. Please see our Response Format section for more information.

Path

idintegerrequired

The ID of the Model.

Query

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

account_membership (AccountMembership) - Retrieves the account membership of the user, which represents the relationship of a user to an account. The response will include account_membership_id, which references the data in the account_memberships top-level key.
custom_field_values (CustomFieldValue) - Retrieves the user's custom field values that are viewable for the current user. The response will include custom_field_value_ids, which references the data in the custom_field_values top-level key.
external_references (ExternalReference) - Includes references to external integrations for this object.
manager (User) - Retrieves the user's manager. The response will include manager_id, which references the data in the users top-level key.
role (Role) - Retrieves the user's account role. The response will include role_id, which references the data in the roles top-level key.
skill_memberships (SkillMembership) - Retrieves the skill memberships of the user, which represent skills that have been assigned to a user. The response will include skill_membership_ids, which references the data in the skill_memberships top-level key. The skill_memberships data will include the user's proficiency level (for skills which can be assigned proficiency levels).
skills (Skill) - Retrieves the user's skills. The response will include skill_ids, which references the data in the skills top-level key. The skills data will include the skill description and category ID.
work_samples (WorkSample) - Retrieves the user's portfolio items. The response will include work_sample_ids, which references the data in the work_samples top-level key.

optional_fieldsArray of strings

Allows you to request one or more optional fields as an array.

Items Enum:"bio""website""city""state""country""abbreviated_timezone""last_site_activity""classification"

Bodyapplication/jsonrequired

userobject

{
  "user": {
    "profile_photo_attachment_file": "string"
  }
}

Responses

User has been created.

Bodyapplication/json

countinteger, (int32)

metaobject

resultsArray of objects

usersobject

external_referencesobject

rolesobject

skillsobject

skill_membershipsobject

account_membershipsobject

work_samplesobject

custom_field_valuesobject

Response

{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "users": {
    "property1": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    },
    "property2": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    }
  },
  "external_references": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "roles": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "skills": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "external_reference_ids": [
        "string"
      ],
      "max_level": "string",
      "name": "string",
      "skill_category_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "external_reference_ids": [
        "string"
      ],
      "max_level": "string",
      "name": "string",
      "skill_category_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "skill_memberships": {
    "property1": {
      "cached_skill_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "level": 0,
      "max_level": 0,
      "skill_id": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    },
    "property2": {
      "cached_skill_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "level": 0,
      "max_level": 0,
      "skill_id": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    }
  },
  "account_memberships": {
    "property1": {
      "backup_approver_association_ids": [
        "string"
      ],
      "bill_rate_in_cents": 0,
      "billability_target": 0,
      "can_create_workspace": true,
      "can_log_in": true,
      "can_view_reports": true,
      "collaborator_only_license": true,
      "cost_rate_ids": [
        "string"
      ],
      "cost_rate_in_cents": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "default_read_only": true,
      "default_role_id": "string",
      "disabled_at": "2019-08-24T14:15:22Z",
      "effective_workweek_id": "string",
      "future_billable_utilization_ids": [
        "string"
      ],
      "is_administrator": true,
      "is_backup_approver": true,
      "is_owner": true,
      "is_project_lead": true,
      "is_punch_clock_user": true,
      "managee_ids": [
        "string"
      ],
      "manager_can_approve": true,
      "manager_can_edit_skills": true,
      "manager_id": "string",
      "non_participant": true,
      "permission": "string",
      "possible_managee_ids": [
        "string"
      ],
      "possible_manager_ids": [
        "string"
      ],
      "should_show_alert_on_timesheet_submission": true,
      "skill_membership_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    },
    "property2": {
      "backup_approver_association_ids": [
        "string"
      ],
      "bill_rate_in_cents": 0,
      "billability_target": 0,
      "can_create_workspace": true,
      "can_log_in": true,
      "can_view_reports": true,
      "collaborator_only_license": true,
      "cost_rate_ids": [
        "string"
      ],
      "cost_rate_in_cents": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "default_read_only": true,
      "default_role_id": "string",
      "disabled_at": "2019-08-24T14:15:22Z",
      "effective_workweek_id": "string",
      "future_billable_utilization_ids": [
        "string"
      ],
      "is_administrator": true,
      "is_backup_approver": true,
      "is_owner": true,
      "is_project_lead": true,
      "is_punch_clock_user": true,
      "managee_ids": [
        "string"
      ],
      "manager_can_approve": true,
      "manager_can_edit_skills": true,
      "manager_id": "string",
      "non_participant": true,
      "permission": "string",
      "possible_managee_ids": [
        "string"
      ],
      "possible_manager_ids": [
        "string"
      ],
      "should_show_alert_on_timesheet_submission": true,
      "skill_membership_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    }
  },
  "work_samples": {
    "property1": {
      "attachment_filename": "string",
      "attachment_id": "string",
      "description": "string",
      "title": "string",
      "trapped_website_url": "string",
      "website_url": "string"
    },
    "property2": {
      "attachment_filename": "string",
      "attachment_id": "string",
      "description": "string",
      "title": "string",
      "trapped_website_url": "string",
      "website_url": "string"
    }
  },
  "custom_field_values": {
    "property1": {
      "account_id": 0,
      "can_edit": true,
      "created_at": "2019-08-24T14:15:22Z",
      "custom_field_id": "string",
      "custom_field_name": "string",
      "display_value": "string",
      "external_reference_ids": [
        "string"
      ],
      "selected_choice_ids": [
        "string"
      ],
      "setter_id": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "type": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "value": "string"
    },
    "property2": {
      "account_id": 0,
      "can_edit": true,
      "created_at": "2019-08-24T14:15:22Z",
      "custom_field_id": "string",
      "custom_field_name": "string",
      "display_value": "string",
      "external_reference_ids": [
        "string"
      ],
      "selected_choice_ids": [
        "string"
      ],
      "setter_id": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "type": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "value": "string"
    }
  }
}