Platform API

<back to all web services

UpdateRoleGroupStatus

Archives or Restores a Role Group record.

Requires Authentication
The following routes are available for this service:
PUT/api/contactrolegroup/{ContactRoleGroupId}/archive
PUT/api/contactrolegroup/{ContactRoleGroupId}/restore
UpdateRoleGroupStatus Parameters:
NameParameterData TypeRequiredDescription
ContactRoleGroupIdqueryGuidYesId of the Contact Role Group record to be Archived or Restored.
IsActionArchivequeryboolYesTrue if the action is Archive, False for Restore.

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

HTTP + CSV

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

PUT /api/contactrolegroup/{ContactRoleGroupId}/archive HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ContactRoleGroupId":"00000000-0000-0000-0000-000000000000","IsActionArchive":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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