Create party

This endpoint is used to add a party to an incident.

post
https://api.claimsmanagertest.crawco.co.uk/incidents/{incidentId}/parties

Path parameters

Parameters marked are required.
Parameter Name Description Type Example Data
incidentId The incident id of the incident to which the party should be added. Integer 6597925

Request body parameters

Parameters marked are required.
Parameter Name Description Type Example Data
partyType The type of the party. string Witness
name The name of the party. string Smith
isOrganisation Flag specifying whether the party is an individual or an organisation. Boolean False
gender The gender of the party. string Male
dateOfBirth The date of birth of the party. string ($date) 1984-01-16
reference A reference to identify the party string MC153536
address Address of the party. string 54 Courtlands Drive Epsom Surrey
postcode Post code of the party. string KT19 0AA
telephoneNumber The telephone number of the party. string 0208 364 5283
emailAddress The email address of the party. string($email) dennis.mccarthy@email.com
linkedClaimants Where the party is related to a claimant, this field should contain the name of relevant claimant string John Smith
extendedFields An array containing any extended fields array See Extended Fields

Example request

curl --location --request POST 'https://api.claimsmanagertest.crawco.co.uk/incidents/6597925/parties' \
--header 'Authorization: Bearer {access token}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "partyType": "Witness",
  "name": "Dennis McCarthy",
  "isOrganisation": false,
  "gender": "Male",
  "dateOfBirth": "1984-01-16",
  "reference": "MC153536",
  "address": "54 Courtlands Drive\r\nEpsom\r\nSurrey",
  "postCode": "KT19 0AA",
  "telephoneNumber": "0208 364 5283",
  "emailAddress": "dennis.mccarthy@email.com"
}'

Response body parameters

Parameters marked are required.
Parameter Name Description Type Example Data
partyId The party id of the newly created party. Integer 50000

Example response

288842