Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

Escalate Response

The response for escalate action.

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links/).

Items1 <= length <= 10

link_description properties

8 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

Match^[\S\s]*$Length0 <= length <= 2147483647

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

Match^[\S\s]*$Length0 <= length <= 2147483647

methodenumOptional

The HTTP method required to make the related call.

Match^[\S\s]*$Length0 <= length <= 2147483647

Allowed values

"GET"
"POST"
"PUT"
"DELETE"
"HEAD"
"CONNECT"
"OPTIONS"
"PATCH"

titlestringOptional

The link title.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaTypestringOptional

The media type, as defined by [RFC 2046](https://www.ietf.org/rfc/rfc2046.txt). Describes the link target.

Match^[\S\s]*$Length0 <= length <= 2147483647

encTypestringOptional

The media type in which to submit the request data.

Default"application/json"Match^[\S\s]*$Length0 <= length <= 2147483647

schemaobject<link_schema>Optional

The schema that describes the request data.

link_schema properties

13 properties

additionalItemsobject<additionalItems>Optional

Any additional items.

dependenciesobject<dependencies>Optional

Any Dependencies.

itemsobject<items>Optional

An item.

patternPropertiesobject<patternProperties>Optional

The pattern properties.

propertiesobject<properties>Optional

Properties.

allOfarray<allOf>Optional

An array of sub-schemas. The data must validate against all sub-schemas.

anyOfarray<anyOf>Optional

An array of sub-schemas. The data must validate against one or more sub-schemas.

oneOfarray<oneOf>Optional

An array of sub-schemas. The data must validate against one sub-schema.

notobject<not>Optional

Not.

linksarray<links>Optional

An array of links.

fragmentResolutionstringOptional

The fragment resolution.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaobject<media>Optional

The media type and context-encoding scheme.

media properties

2 properties

typestringOptional

The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).

Match^[\S\s]*$Length0 <= length <= 2147483647

binaryEncodingstringOptional

The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).

Match^[\S\s]*$Length0 <= length <= 2147483647

pathStartstringOptional

To apply this schema to the instances' URIs, start the URIs with this value.

FormaturiLength0 <= length <= 2147483647

targetSchemaobject<link_schema>Optional

The schema that describes the link target.

link_schema properties

13 properties

additionalItemsobject<additionalItems>Optional

Any additional items.

dependenciesobject<dependencies>Optional

Any Dependencies.

itemsobject<items>Optional

An item.

patternPropertiesobject<patternProperties>Optional

The pattern properties.

propertiesobject<properties>Optional

Properties.

allOfarray<allOf>Optional

An array of sub-schemas. The data must validate against all sub-schemas.

anyOfarray<anyOf>Optional

An array of sub-schemas. The data must validate against one or more sub-schemas.

oneOfarray<oneOf>Optional

An array of sub-schemas. The data must validate against one sub-schema.

notobject<not>Optional

Not.

linksarray<links>Optional

An array of links.

fragmentResolutionstringOptional

The fragment resolution.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaobject<media>Optional

The media type and context-encoding scheme.

media properties

2 properties

typestringOptional

The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).

Match^[\S\s]*$Length0 <= length <= 2147483647

binaryEncodingstringOptional

The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).

Match^[\S\s]*$Length0 <= length <= 2147483647

pathStartstringOptional

To apply this schema to the instances' URIs, start the URIs with this value.

FormaturiLength0 <= length <= 2147483647

Back to top

Escalate Response

The response for escalate action.

linksobject<link_description>[]Optional

An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links/).

Items1 <= length <= 10

link_description properties

8 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

Match^[\S\s]*$Length0 <= length <= 2147483647

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

Match^[\S\s]*$Length0 <= length <= 2147483647

methodenumOptional

The HTTP method required to make the related call.

Match^[\S\s]*$Length0 <= length <= 2147483647

Allowed values

"GET"
"POST"
"PUT"
"DELETE"
"HEAD"
"CONNECT"
"OPTIONS"
"PATCH"

titlestringOptional

The link title.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaTypestringOptional

The media type, as defined by [RFC 2046](https://www.ietf.org/rfc/rfc2046.txt). Describes the link target.

Match^[\S\s]*$Length0 <= length <= 2147483647

encTypestringOptional

The media type in which to submit the request data.

Default"application/json"Match^[\S\s]*$Length0 <= length <= 2147483647

schemaobject<link_schema>Optional

The schema that describes the request data.

link_schema properties

13 properties

additionalItemsobject<additionalItems>Optional

Any additional items.

dependenciesobject<dependencies>Optional

Any Dependencies.

itemsobject<items>Optional

An item.

patternPropertiesobject<patternProperties>Optional

The pattern properties.

propertiesobject<properties>Optional

Properties.

allOfarray<allOf>Optional

An array of sub-schemas. The data must validate against all sub-schemas.

anyOfarray<anyOf>Optional

An array of sub-schemas. The data must validate against one or more sub-schemas.

oneOfarray<oneOf>Optional

An array of sub-schemas. The data must validate against one sub-schema.

notobject<not>Optional

Not.

linksarray<links>Optional

An array of links.

fragmentResolutionstringOptional

The fragment resolution.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaobject<media>Optional

The media type and context-encoding scheme.

media properties

2 properties

typestringOptional

The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).

Match^[\S\s]*$Length0 <= length <= 2147483647

binaryEncodingstringOptional

The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).

Match^[\S\s]*$Length0 <= length <= 2147483647

pathStartstringOptional

To apply this schema to the instances' URIs, start the URIs with this value.

FormaturiLength0 <= length <= 2147483647

targetSchemaobject<link_schema>Optional

The schema that describes the link target.

link_schema properties

13 properties

additionalItemsobject<additionalItems>Optional

Any additional items.

dependenciesobject<dependencies>Optional

Any Dependencies.

itemsobject<items>Optional

An item.

patternPropertiesobject<patternProperties>Optional

The pattern properties.

propertiesobject<properties>Optional

Properties.

allOfarray<allOf>Optional

An array of sub-schemas. The data must validate against all sub-schemas.

anyOfarray<anyOf>Optional

An array of sub-schemas. The data must validate against one or more sub-schemas.

oneOfarray<oneOf>Optional

An array of sub-schemas. The data must validate against one sub-schema.

notobject<not>Optional

Not.

linksarray<links>Optional

An array of links.

fragmentResolutionstringOptional

The fragment resolution.

Match^[\S\s]*$Length0 <= length <= 2147483647

mediaobject<media>Optional

The media type and context-encoding scheme.

media properties

2 properties

typestringOptional

The media type. See [Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types](https://tools.ietf.org/html/rfc2046).

Match^[\S\s]*$Length0 <= length <= 2147483647

binaryEncodingstringOptional

The content-encoding scheme. See [Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://tools.ietf.org/html/rfc2045).

Match^[\S\s]*$Length0 <= length <= 2147483647

pathStartstringOptional

To apply this schema to the instances' URIs, start the URIs with this value.

FormaturiLength0 <= length <= 2147483647

Escalate Response

link_description properties

link_schema properties

media properties

link_schema properties

media properties

Back to top

On this page

On this page

Escalate Response

link_description properties

link_schema properties

media properties

link_schema properties

media properties

Back to top

On this page

Escalate Response

link_description properties

link_schema properties

media properties

link_schema properties

media properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Escalate Response

link_description properties

link_schema properties

media properties

link_schema properties

media properties

Back to top

On this page