Update a global field
PUT https://{{base_url}}/v3/global_fields/{{global_field_uid}}
The Update a global field request allows you to update the schema of an existing global field.
To configure the permissions for your application via OAuth, please include the cm.global-fields.management:write scope.
To use the API Request, you will need to authenticate yourself either with a Management Token (highly recommended) or an Authtoken.Â
Read more about it in Authentication.
For more information, refer to the Update a global field API Reference document
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
include_branch | boolean | Set this to 'true' to include the '_branch' top-level key in the response. This key states the unique ID of the branch where the concerned Contentstack module resides. |
Request Body
{"global_field"=>{"title"=>"Servlet", "uid"=>"servlet", "schema"=>[{"display_name"=>"Name", "uid"=>"name", "data_type"=>"text"}, {"data_type"=>"text", "display_name"=>"Rich text editor", "uid"=>"description", "field_metadata"=>{"allow_rich_text"=>true, "description"=>"", "multiline"=>false, "rich_text_type"=>"advanced", "version"=>3}, "multiple"=>false, "mandatory"=>false, "unique"=>false}]}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
api_key | string | ||
authtoken | string | Enter your authtoken. | |
authorization | string | For this call we recommend you to use management token. | |
branch | string | Enter your branch unique ID. | |
Content-Type | string |