Skip to main content

Update a profile key

patch/v1/profiles/{id}

Update a profile key

Request

Parameters

NameInTypeDescription
id*pathintegerNo description

Body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 255
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 1000
          },
          "metadata": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            }
          },
          "is_active": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Responses

200No description
Schema Structure
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"metadata": {
"type": "string"
},
"is_active": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"key",
"name",
"description",
"metadata",
"is_active",
"updated_at"
]
},
"message": {
"type": "string",
"enum": [
"Profile key updated successfully"
]
}
},
"required": [
"success",
"data",
"message"
]
}
422No description
Schema Structure
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"VALIDATION_ERROR"
]
},
"message": {
"type": "string",
"enum": [
"Validation failed"
]
},
"details": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"title": "MessageBag"
}
},
"required": [
"code",
"message",
"details"
]
}
},
"required": [
"success",
"error"
]
}