---
updatedAt: 2026-04-22T18:03:46.000Z
agentTools:
  projectIndex: https://docs.zype.com/llms.txt
---

# Update user

Update a single user on your property

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Platform",
    "version": "1.0.0",
    "description": ""
  },
  "servers": [
    {
      "url": "https://api.zype.com/"
    }
  ],
  "security": [
    {
      "api_key": []
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "api_key",
        "in": "query"
      }
    }
  },
  "paths": {
    "/videos": {
      "get": {
        "tags": [
          "Videos"
        ],
        "summary": "List Videos",
        "description": "Retrieve a list of videos from your library",
        "operationId": "listVideos",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Filter records by ID\nExample: `id=5992f328ce593000ef000008`",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "q",
            "in": "query",
            "description": "Filters by keyword, title, source id, id, zobject title",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "active",
            "in": "query",
            "required": false,
            "description": "Filter by active, inactive, or all.  If excluded, query will default to 'true'",
            "schema": {
              "type": "string",
              "enum": [
                "true",
                "false",
                "all"
              ],
              "nullable": true
            }
          },
          {
            "name": "friendly_title",
            "in": "query",
            "description": "Filter records by friendly title",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "source_id",
            "in": "query",
            "description": "Filter records by source identifier",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "on_air",
            "in": "query",
            "description": "Filter records that are either on or off air",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "live_event",
            "in": "query",
            "description": "Filter records that are live events",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "video_source_type",
            "in": "query",
            "description": "Filter records by video source type. Multiple types can be provided by passing a comma-separated list. Examples: `zype`, `hulu`, `youtube`, `crunchyroll`",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "crunchyroll_id",
            "in": "query",
            "description": "Filter records by Crunchyroll ID",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "vimeo_id",
            "in": "query",
            "description": "Filter records by Vimeo ID",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "youtube_id",
            "in": "query",
            "description": "Filter records by YouTube ID",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "hulu_id",
            "in": "query",
            "description": "Filter records by Hulu ID",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "mature_content",
            "in": "query",
            "description": "Filter records flagged as mature",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "parental_guidelines_rating",
            "in": "query",
            "description": "Parental guidance rating of the video",
            "style": "form",
            "explode": true,
            "schema": {
              "title": "ParentalGuidelinesRatingProperties",
              "enum": [
                "tv-y",
                "tv-y7",
                "tv-y7_fv",
                "tv-g",
                "tv-pg",
                "tv-14",
                "tv-ma",
                "g",
                "pg",
                "pg-13",
                "r",
                "nc-17",
                "10",
                "12",
                "13",
                "14",
                "16",
                "18",
                "l",
                "a",
                "aa",
                "b",
                "b15",
                "c",
                "d",
                "not_rated",
                "tv-15-17",
                "tv-ao",
                "atp"
              ],
              "type": "string",
              "nullable": true,
              "description": "Parental guidance rating of the video"
            }
          },
          {
            "name": "dpt",
            "in": "query",
            "description": "Filter records by Dynamic Player Technology conditions (Geo-location and device restrictions). If set to `true` this will return videos that are playable from your location/device.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "created_at",
            "in": "query",
            "description": "Filter records by created date using times in ISO8601 format (Example: `2017-01-01T00:00:00-00:00`) or Unix timestamps (Example: `1483228800`) **Note**: Range filters can be applied by adding a suffix: ‘.gt’, ‘.gte’, ‘.lt’, ‘lte’ (Example: `created_at.gte`)",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "published_at",
            "in": "query",
            "description": "Filter records by published date using times in ISO8601 format Example: `2017-01-01T00:00:00-00:00` or Unix timestamps `1483228800`.\nNote: Range filters can be applied by adding a suffix: `.gt`, `.gte`, `.lt`, `.lte` Example: `published_at.gte=2017-01-01T00:00:00-00:00`",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "category",
            "in": "query",
            "required": false,
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            },
            "description": "Filter records that match all category values listed.\nExample: `category[genre][]=comedy&category[language][]=english` Matches all playlists having ALL of the category name/value pairs listed."
          },
          {
            "name": "category_or",
            "in": "query",
            "required": false,
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            },
            "description": "Filter records that match any category values listed.\nExample: `category_or[genre][]=comedy&category_or[language][]=english` Matches all playlists that have ANY of the category name/value pairs listed."
          },
          {
            "name": "category_and",
            "in": "query",
            "required": false,
            "style": "deepObject",
            "explode": true,
            "schema": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            },
            "description": "Filter records that match all category values listed.\nExample: `category[genre][]=comedy&category[language][]=english` Matches all playlists having ALL of the category name/value pairs listed."
          },
          {
            "name": "zobject_id",
            "in": "query",
            "description": "Filter records that match any of the Zobject IDs listed",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "zobject_id_or",
            "in": "query",
            "description": "Filter records that match any of the Zobject IDs listed",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "zobject_id_and",
            "in": "query",
            "description": "Filter records that match all of the Zobject IDs listed",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "zobject_details",
            "$ref": "#/paths/~1playlists~1{id}~1videos/get/parameters/5"
          },
          {
            "name": "zobject_types",
            "$ref": "#/paths/~1playlists~1{id}~1videos/get/parameters/6"
          },
          {
            "name": "zobject_fields",
            "$ref": "#/paths/~1playlists~1{id}~1videos/get/parameters/7"
          },
          {
            "name": "include_related_videos",
            "in": "query",
            "description": "When it's set to true, it will include the related videos in the API response",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "expand_related_videos",
            "in": "query",
            "description": "When it's set to true along with the include_related_videos flag, the API response will also include the data of linked videos appart from the target one.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "response_fields",
            "in": "query",
            "description": "Filter returned fields. Example: response_fields=id,title,description",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "order",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ]
            },
            "description": "Filter by ascending or descending order"
          },
          {
            "name": "sort",
            "$ref": "#/paths/~1playlists~1{id}~1videos/get/parameters/3"
          },
          {
            "name": "page",
            "$ref": "#/paths/~1playlists~1{id}~1videos/get/parameters/1"
          },
          {
            "name": "per_page",
            "$ref": "#/paths/~1playlists~1{id}~1videos/get/parameters/2"
          }
        ],
        "responses": {
          "200": {
            "description": "Response will contain an array of videos",
            "content": {
              "application/json": {
                "schema": {
                  "title": "VideosResponse",
                  "type": "object",
                  "properties": {
                    "response": {
                      "type": "array",
                      "items": {
                        "$ref": "#/paths/~1videos/post/responses/201/content/application~1json/schema/properties/response"
                      },
                      "description": ""
                    },
                    "pagination": {
                      "title": "Pagination",
                      "type": "object",
                      "properties": {
                        "current": {
                          "type": "number",
                          "format": "int32",
                          "description": "The current page of results"
                        },
                        "previous": {
                          "type": "number",
                          "format": "int32",
                          "description": "the previous page of results",
                          "nullable": true
                        },
                        "next": {
                          "type": "number",
                          "format": "int32",
                          "description": "the next page of results",
                          "nullable": true
                        },
                        "per_page": {
                          "type": "number",
                          "format": "int32",
                          "description": "the number of results returned per page"
                        },
                        "pages": {
                          "type": "number",
                          "format": "int32",
                          "description": "the total number of pages available, using per_page"
                        }
                      },
                      "example": {
                        "current": 1,
                        "previous": null,
                        "next": 2,
                        "per_page": 10,
                        "pages": 20
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Unprocessable Entity",
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    },
    "/app": {
      "get": {
        "summary": "View App",
        "tags": [
          "Apps"
        ],
        "operationId": "getApp",
        "parameters": [
          {
            "name": "app_key",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "App key provided by Zype"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "title": "AppResponse",
                  "type": "object",
                  "properties": {
                    "response": {
                      "type": "object",
                      "title": "App",
                      "properties": {
                        "_id": {
                          "type": "string"
                        },
                        "active": {
                          "type": "boolean"
                        },
                        "app_type_id": {
                          "type": "string"
                        },
                        "device_ids": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "site_id": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "version": {
                          "type": "string"
                        },
                        "store_icon_url": {
                          "type": "string"
                        }
                      },
                      "example": {
                        "_id": "593b1ac8830ece0024000005",
                        "active": false,
                        "app_type_id": "1593030e94d740d00530000971",
                        "device_ids": [
                          "593030d64d740d0053000007"
                        ],
                        "site_id": "593031674d740d01cd000000",
                        "title": "Apple TV App",
                        "version": "0.1.0",
                        "store_icon_url": "https:/url"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "App not found",
            "content": {
              "application/json": {
                "schema": {
                  "title": "NotFound",
                  "type": "object",
                  "required": [
                    "message"
                  ],
                  "properties": {
                    "message": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/site/users": {
      "post": {
        "summary": "Create User",
        "description": "Add an admin user to your property",
        "operationId": "createUser",
        "tags": [
          "Users"
        ],
        "requestBody": {
          "description": "",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "title": "UserRequest",
                "type": "object",
                "required": [
                  "user"
                ],
                "properties": {
                  "user": {
                    "type": "object",
                    "title": "UserProperties",
                    "properties": {
                      "first_name": {
                        "type": "string",
                        "description": "The first name of the admin user"
                      },
                      "last_name": {
                        "type": "string",
                        "description": "The last name of the admin user"
                      },
                      "email": {
                        "type": "string",
                        "description": "The email address of the admin user"
                      },
                      "role": {
                        "type": "string",
                        "description": "Admin role type assigned to user -- must be either 'admin', 'finance_manager', or 'content_manager'. Default is 'admin' if omitted."
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "User object is returned.",
            "content": {
              "application/json": {
                "schema": {
                  "title": "UserResponse",
                  "type": "object",
                  "properties": {
                    "response": {
                      "type": "object",
                      "title": "User",
                      "properties": {
                        "_id": {
                          "type": "string"
                        },
                        "first_name": {
                          "type": "string"
                        },
                        "last_name": {
                          "type": "string"
                        },
                        "email": {
                          "type": "string"
                        },
                        "phone_number": {
                          "type": "string"
                        },
                        "role_ids": {
                          "type": "array"
                        },
                        "notifications_enabled": {
                          "type": "boolean"
                        },
                        "sign_in_count": {
                          "type": "number"
                        },
                        "last_sign_in_at": {
                          "type": "string"
                        },
                        "current_sign_in_at": {
                          "type": "string"
                        },
                        "last_sign_in_ip": {
                          "type": "string"
                        },
                        "current_sign_in_ip": {
                          "type": "string"
                        },
                        "time_zone": {
                          "type": "string"
                        },
                        "created_at": {
                          "type": "string"
                        },
                        "updated_at": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1videos/get/responses/422/content/application~1json/schema"
                }
              }
            }
          }
        }
      }
    },
    "/site/users/{id}": {
      "put": {
        "description": "Update a single user on your property",
        "summary": "Update user",
        "tags": [
          "Users"
        ],
        "operationId": "updateUser",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "ID of user"
          }
        ],
        "requestBody": {
          "description": "",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/paths/~1site~1users/post/requestBody/content/application~1json/schema"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Update user",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1site~1users/post/responses/200/content/application~1json/schema"
                }
              }
            }
          },
          "404": {
            "description": "User not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1app/get/responses/404/content/application~1json/schema"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable entity",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/paths/~1videos/get/responses/422/content/application~1json/schema"
                }
              }
            }
          }
        }
      }
    }
  }
}
```