Contacts

Create Contact Relationship

Create a relationship between a contact and a non-marketable relationship contact, such as a guarantor.

post/contacts/{contactId}/relationship

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/contacts/{contactId}/relationship
  • Auth: appAuth (a scheme the document does not define)

Path parameters

contactIdstring required

Headers

AgencyRefstring required

Request body

relationshipType'TenantGuarantor' | 'ForwardingAddress' required

The Relationship's type

relatedContactIdstring required

The ID of the contact we will create a relationship with. This will have to be created using POST /contact with a Category - ContactRelationship

Example request

{
  "relationshipType": "TenantGuarantor",
  "relatedContactId": "1234"
}

Response

Contact relationship created.

idstring nullable

The unique identifier for the resource.

relationshipType'TenantGuarantor' | 'ForwardingAddress'

The Relationship's type

contactIdstring nullable

The identifier of the Contact we added a relationship to

relatedContactIdstring nullable

The ID of the contact we will create a relationship with. This will have to be created using POST /contact with a Category - ContactRelationship

Example response

{
  "relationshipType": "TenantGuarantor"
}

Changes

No recorded changes to this operation across all 1 revision of this API.