POST /config/store_and_forward/policies/{id}

Updates the store and forward policy owner only.

Updates the store and forward policy owner only

Table 1. POST /config/store_and_forward/policies/{id} resource details
MIME Type
application/json

Table 2. POST /config/store_and_forward/policies/{id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	Number (Integer)	text/plain	null
fields	header	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. POST /config/store_and_forward/policies/{id} request body details
Parameter	Data Type	MIME Type	Description	Sample
policy	Object	application/json	null	{ "description": "String", "id": 42, "name": "String", "owner": "String", "saf_schedule_id": 42, "timezone": "String" }

Table 4. POST /config/store_and_forward/policies/{id} response codes
HTTP Response Code	Unique Code	Description
200		The store and forward policy has been updated.
403	1009	You do not have the required capabilities to update the store and forward policy.
404	1002	The store and forward policy does not exist.
409	1004	The provided user does not have the required capabilities to own the store and forward policy.
422	1005	A request parameter is not valid.
500	1020	An error occurred during the attempt to update the store and forward policy.

Response Description

The store and forward policy after it was updated. An Store and Forward Policy object contains the following fields:

id - Long - The ID of the store and forward policy.
name - String - The name of the store and forward policy.
description - String - The description of the store and forward policy.
timezone - String - The timezone of the store and forward policy.
owner - String - The owner of the store and forward policy.
store_and_forward_schedule_id - Long - The schedule ID of the store and forward policy.
created - Long - The time in milliseconds since epoch since the store and forward policy was created.
modified - Long - The time in milliseconds since epoch since the store and forward policy was last modified.

Response Sample


{
    "created": 42,
    "description": "String",
    "id": 42,
    "modified": 42,
    "name": "String",
    "owner": "String",
    "saf_schedule_id": 42,
    "timezone": "String"
}