PUT 3dCartWebAPI/v1/Webhooks/{id}


This method is used to update a single webhook record in the database. The {id} parameter specifies which webhook record to update.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Webhook Id

integer

Required

Body Parameters

A Json or XML object containing the Webhook

WebhookPUT
NameDescriptionTypeAdditional information
Id

database reference = webhooks.id

integer

None.

Name

database reference = webhooks.name

string

String length: inclusive between 0 and 80

Url

database reference = webhooks.url

string

String length: inclusive between 0 and 1000

Enabled

database reference = webhooks.enabled

boolean

None.

Format

(JSON | XML) database reference = webhook_formats.format_name

string

String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 1",
  "Url": "sample string 2",
  "Enabled": true,
  "Format": "sample string 3"
}

application/xml, text/xml

Sample:
<WebhookPUT xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <Name>sample string 1</Name>
  <Url>sample string 2</Url>
  <Enabled>true</Enabled>
  <Format>sample string 3</Format>
</WebhookPUT>

Sample Request



Response Information

application/json, text/json

Sample:
[
    {
    "Key":"Id",
    "Value":"1234",
    "Status":"200",
    "Message":"updated successfully",
    }
]
						

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.