PUT List/ConsentSource/Items/{id}

Some tooltip text!

• 3 minutes to read

 • 3 minutes to read

PUT /api/v1/List/ConsentSource/Items/{id}

Updates the existing ConsentSource

Calls the List agent service SaveConsentSource.

Path Part	Type	Description
id	int32	The id of ConsentSource to be saved. Required

Request Headers

Parameter Name	Description
Authorization	Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN	If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type	Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept	Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language	Convert string references and multi-language values into a specified language (iso2) code.
SO-Language	Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture	Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone	Specify the timezone code that you would like date/time responses converted to.
SO-AppToken	The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: entity

The details of ConsentSource to be saved.

Property Name	Type	Description
ConsentSourceId	Integer	Primary key
Name	String	Name of consent source
Tooltip	String	Tooltip for this consent source
Rank	Integer	Rank of this consent source
Key	String	The key used to uniquely identify this consent source
MailTemplateId	Integer	The mail template to use when automatically sending emails to new persons created with this consent source.
Deleted	Boolean	true if the ConsentSource is deleted

Response:

OK

Response	Description
200	OK
400	Bad request. Entity to save is not in request body.

Response body: ConsentSource

Property Name	Type	Description
ConsentSourceId	int32	Primary key
Name	string	Name of consent source
Tooltip	string	Tooltip for this consent source
Rank	int32	Rank of this consent source
Key	string	The key used to uniquely identify this consent source
MailTemplateId	int32	The mail template to use when automatically sending emails to new persons created with this consent source.
Deleted	bool	true if the ConsentSource is deleted
TableRight	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.

Sample request

PUT /api/v1/List/ConsentSource/Items/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "ConsentSourceId": 171,
  "Name": "Konopelski LLC",
  "Tooltip": "aperiam",
  "Rank": 480,
  "Key": "corporis",
  "MailTemplateId": 125,
  "Deleted": true
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "ConsentSourceId": 592,
  "Name": "Donnelly, Berge and Terry",
  "Tooltip": "tenetur",
  "Rank": 192,
  "Key": "officia",
  "MailTemplateId": 159,
  "Deleted": false,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 571
    }
  }
}