Platform API

<back to all web services

UpdateContactRoleGroup

Update contact role group

Requires Authentication
The following routes are available for this service:
PUT/api/contactrolegroups
UpdateContactRoleGroup Parameters:
NameParameterData TypeRequiredDescription
RoleGroupIdqueryGuidYesGuid of the Contact Role Group to be updated.
NamequerystringYesContact role group name to be updated
RolesbodyList<ListItemModel>No
ListItemModel Parameters:
NameParameterData TypeRequiredDescription
ListItemIdformGuidNo
NameformstringNo
DescriptionformstringNo
ShortNameformstringNo
IsDefaultformboolNo
OrderformintNo
ListItemTrafficLightIdformGuidNo
PrimaryListItemImageIdformGuidNo
PrimaryListItemImageUrlformstringNo
PrimaryImageThumbnailUrlformstringNo
OwnerContactIdformGuidNo
RecordStatusformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /api/contactrolegroups HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RoleGroupId":"00000000-0000-0000-0000-000000000000","Name":"String","Roles":[{"ListItemId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","IsDefault":false,"Order":0,"ListItemTrafficLightId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageId":"00000000-0000-0000-0000-000000000000","PrimaryListItemImageUrl":"String","PrimaryImageThumbnailUrl":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}