Add Custom Field onto Party

[Matthew Bristow]

Hello,

Is it possible to add a custom field onto the body of the party (in v1 you would include the PartyID) without creating a field definition on the capsule account?

Many thanks,

Matt

[andrew...@zestia.com]

Hi Matt,

To add an existing custom field to a party, the request would look like:

// PUT /api/v2/parties/123
{
  "party": {
    "fields": [{
      "value": "Test",
      "definition": {
        "id": 456
      }
    }]
  }
}

When retrieving the party, make sure to include ?embed=fields on the URL, this will return:

// GET /api/v2/parties/123?embed=fields
{
  "party": {
    "id": 123,
    "fields": [{
      "id": 789,
      "value": "Test",
      "definition": {
        "id": 456,
        "name": "Your existing custom field"
      }
    }]
  }
}

You can find out more here https://developer.capsulecrm.com/v2/operations/Custom_Field