Partial update Keyword Redirect Group.

patch

/gsadmin/v1/{appName}/redirects/{redirectGroup}

Partial update keyword redirect group configuration of the specified application's redirects.

• Request
• Response
• Examples

Request

Supported Media Types

• application/json

Path Parameters

appName

Type: string

Required: true

Specifies the name of your application, for example, Discover.

redirectGroup

Type: string

Required: true

Specifies the redirect group name, for example, Default

Body Parameter

The request body represents the partially updated redirects.

Root Schema : RedirectGroup

Type: object

Represents a Redirect Group configuration. Child Nodes represent Redirect Entry configuration confirming to RedirectEntry JSON schema

Properties

ecr:createDate

Type: string

ecr:lastModified

Type: string

ecr:lastModifiedBy

Type: string

ecr:type

Type: string

Default Value: redirect-group

Security

basicAuth

Type: basic

Description: Basic username/password authentication.

Response

Supported Media Types

• application/json

202 Response

Keyword Redirect Group successfully updated.

Body

Root Schema : Response

Type: object

Properties

message

Type: string

status

Type: integer (int32)

Examples

A PATCH endpoint cannot access an object through its parent object. Thus, you cannot use this endpoint to modify the redirect-entry objects contained in the redirect-group object. The following request generates an error:

PATCH /gsadmin/v1/cloud/redirects/Default

Request Body Example

{
  "ecr:type": "redirect-group",
  "id1": {
    "ecr:type": "redirect-entry",
    "url": "/browse/Canon/_/N-1z162xy",
    },
  "id2": {
    "ecr:type": "redirect-entry",
    "searchTerms": "contact",
    }
}