Update Prospect Attribute
POST /v1/prospects/{prospectId}/attribute
/v1/prospects/{prospectId}/attribute{prospectId}/attributeUpdate prospect field values
Sets or updates the value of one or more fields on a prospect profile. To update a single field, provide fieldId and attributeValue. To update multiple fields in one request, provide an attributes array where each item contains a fieldId and the new value. Use the field IDs returned by the GET /fields endpoint.
Authorization
x-api-key<token>
API key for Open API authentication
In: header
Request Body
application/jsonRequiredTo update a single field, provide fieldId and attributeValue. To update multiple fields in one request, provide an attributes array — each item must contain a fieldId and attributeValue. Use the field IDs returned by the GET /fields endpoint.
fieldIdstring
The ID of the field to update. Use this for updating a single field. Use the field IDs returned by the GET /fields endpoint. Required when "attributes" is not provided.
Example:"1qPB1GBBwD"attributeValuestring
The new value to set for the field specified by "fieldId". Required when "fieldId" is provided.
Example:"Smith"attributesarray<object>
A list of field updates to apply in a single request. Use this to update multiple fields at once. Each item must specify a fieldId and the new value. When this is provided, "fieldId" and "attributeValue" are ignored.
Example:[{"fieldId":"BVaD1mKgzo","attributeValue":"John"},{"fieldId":"1qPB1GBBwD","attributeValue":"Smith"}]Path Parameters
prospectIdstring
Public prospect ID returned by prospect read/list APIs.
Request Body Examples
{
"fieldId": "1qPB1GBBwD",
"attributeValue": "Smith"
}Responses
{
"message": "Prospect attribute updated successfully",
"payload": {
"results": [
{
"fieldId": "Vj9kLp2Q",
"success": true
},
{
"fieldId": "r8PqN2xA",
"success": true
},
{
"fieldId": "INVALIDxx",
"success": false
}
]
}
}