Add a Custom Reference ID to a negotiation

Please ensure that you have reviewed the prerequisites before following this guide.

1. Get a negotiation ID

This assumes that you have a Negotiation ID - this is either the ID of a negotiation one of your users has created or the ID of a negotiation that you've created using the API. Detailed negotiation creation instructions are available in our Create a negotiation guide.

2. Set a Custom Reference ID

Request

A Custom Reference ID is a Custom Field. To update the Custom Fields for a negotiation we can call:

PUT https://sandbox-api.app.createiq.tech/api/v1/subAccounts/:subAccountId/negotiations/:negotiationId/customFields

The payload includes two optional keys:

referenceId is the Custom Reference ID we're looking to set here. It is limited to 1000 characters.

displayReferenceId sets the user-visible reference ID on CreateiQ. This is limited to 8 characters and must be unique.

If a display reference ID is present on the negotiation and not repeated here it will be removed. i.e. This endpoint only performs holistic updates of Custom Fields.

Assuming that there's no existing displayReferenceId our payload will be:


{
  "referenceId": "My-Long-Company-Custom-Reference-Id-Here"
}

Response

A full negotiation response (Example in Appendix II). This includes the customReferenceId that we've just set under the key customFields.

🚀 Congratulations! You've now set a Custom Reference ID on a negotiation.