Create / Update contact profile API

This API is used to create or update a contact profile that matches the given criteria.

📘

Know your endpoint

Based on the domain you use to log in to Webex Campaign, the endpoint domain for your API varies. For more information, refer to the Know Your API Endpoints section.

Go to the Postman Collection section to learn how to import a Postman collection. Click the below button, If you already know how to import a postman collection.

Request Headers

The following table describes the request headers:

Request Parameters

The following table describes the elements in the request body:

Request Example

{

	
	"profile-name": "profile_test",
	"upsert": "1",
	"attributes": [{
	
		"attribute-name": "firstname",
		"val": "Matt"
		}, {

		"attribute-name": "lastname",
		"val": "Adam"
		}
	     ],
	"filter": [{
	
		"attribute-name": "",
		"rel-op": "equals",
		"val": "1",
		"logical-op": "and"
		}, {
	
		"attribute-name": "atbname1",
		"rel-op": "equals",
		"val": "1",
		"logical-op": "and"
		}
	     ]

}

Response Parameters

This API will return the following response parameters:

📘

Under certain conditions, this API may return "200 OK" and "update-count" response parameter value as '0'. This may indicate that your request body param values could be incorrect, if you were expecting one or more profile records to be created or updated.

Therefore, we recommend that within your application that invokes this API, you should interrogate not just the 'Response Code', but also the value of the 'update-count' response parameter. Then you can write some logic within your application to throw an error if the 'update-count' unexpectedly returns a '0' value. This will help you diagnose any errors within your request body parameters.

Failure Response Codes

The API will return code within the response as per the following table in case of failure scenarios.