From Bright Pattern Documentation
< 5.2:List-management-api-specification
Revision as of 04:32, 29 May 2024 by BpDeeplTranslateMaintenance (talk | contribs) (Updated via BpDeleteTranslateTags script)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
• 5.19 • 5.2 • 5.3 • 5.8

Add Record

This method adds a single new record to the specified calling list. It returns an error if a record with the same values of unique keys as configured in the list definition already exists.

Request

URL

http[s]://<host>/configapi/v2/callinglist/add/<list_name>

Method

POST

Body Content Type

JSON object

Body

{
"fieldName_1":"value_1",
...
"fieldName_n":"value_n"
} 

Notes

  • Field names are provided as they were defined during list creation.
  • Key fields and required fields are mandatory.

Response Codes

Code Description
200 Success (response body is empty)
400 Bad request (missing required fields or format not understood)
401 Authentication failed
403 User authenticated but does not have sufficient privileges
404 Calling List is not found or invalid URL
500 Duplicate key error
< Previous | Next >