Difference between revisions of "User: JenkinsSBO"
From Genesys Documentation
JenkinsSBO (talk | contribs) (Replaced content with "|security= }}") (Tag: Replaced) |
JenkinsSBO (talk | contribs) |
||
| Line 1: | Line 1: | ||
| + | {{YAML | ||
| + | |id= | ||
| + | yaml-32-2 | ||
| + | |method= | ||
| + | DELETE | ||
| + | |content= | ||
| + | |||
| + | |path= | ||
| + | /agents | ||
| + | |parameters= | ||
| + | {{{!}} | ||
| + | ! Name | ||
| + | ! Located in | ||
| + | ! Description | ||
| + | ! Required | ||
| + | ! Schema | ||
| + | {{!}}- | ||
| + | {{!}} json | ||
| + | {{!}} body | ||
| + | {{!}} A valid JSON containing '''''token''''' '''id''' | ||
| + | {{!}} Yes | ||
| + | {{!}} object | ||
| + | {{!}}} | ||
| + | |summary=Delete agent record. | ||
| + | |description= | ||
| + | A DELETE rest endpoint to delete agent records. | ||
| + | |||
| + | <pre>curl -X DELETE \\ | ||
| + | 'https://app.journeyoptimization.com/api/v2.0/agents' \\ | ||
| + | -H 'Content-Type: application/json' \\ | ||
| + | -d '{ | ||
| + | "token": "token", | ||
| + | "id": "ID1" | ||
| + | }'</pre> | ||
| + | |responses= | ||
| + | {{{!}} | ||
| + | ! Code | ||
| + | ! Description | ||
| + | {{!}}} | ||
| + | |||
| + | {{!}} 200 {{!}} A JSON response is returned. Refer below examples.<br><br>'''Example''' (''JSON response''):<br> | ||
| + | <pre>{<br> "ok": true,<br> "removed_count": 1<br>}</pre> | ||
| + | {{!}} | ||
|security= | |security= | ||
}} | }} | ||
Revision as of 08:21, October 7, 2020
DELETE /agents
Delete agent record.
Description
A DELETE rest endpoint to delete agent records.
curl -X DELETE \\
'https://app.journeyoptimization.com/api/v2.0/agents' \\
-H 'Content-Type: application/json' \\
-d '{
"token": "token",
"id": "ID1"
}'
Parameters[edit source]
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| json | body | A valid JSON containing token id | Yes | object |
Responses
| Code | Description |
|---|
| 200 | A JSON response is returned. Refer below examples.
Example (JSON response):
{<br> "ok": true,<br> "removed_count": 1<br>}
|