classifiedIdstring(uuid)required
ID of classified to update
>= 1 characters
Detach all media from the classified.
Detach all media from the classified
delete
Path Parameters
Headers
traceparentstring
Identifies the incoming request in the tracing system
Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01
User-Agentstringrequired
Characteristic string that identifies the application, operating system, vendor, and version of the requesting user agent.
Syntax : User-Agent: <crm-software-name>/<crm-software-version> <tool-name>/<tool-version> <operating-system>/<operating-system-version>
All subset parts of this string do not allow the following characters : / and (whitespace)
Match pattern:^[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+$
Example:MyAwesomeSoft/1.0.0 curl/7.52.1 debian/9~1.gbpf8534c
authorizationstringrequired
Bearer token to authenticate request
Example:Bearer <token>
Response
application/json
Response
application/json
Accepted
messagestring
Accepted message
Example:Your request has been accepted
delete/classifieds/{classifiedId}/media
Authentication
Path Parameters
Headers
application/json
Update the metadata of a classified media.
Applies the requested changes to the given classified media (modify/remove metadata). Read RfC 6902 - JSON Patch for more information.
At the moment, the following properties can be patched:
- title
- displayOrder
- category
Samples
Adding or updating the displayOrder
[
{
"op": "add",
"path": "/displayOrder",
"value": 3
}
]
Removing the title
[
{
"op": "remove",
"path": "/title"
}
]
Adding or updating the category
[
{
"op": "add",
"path": "/category",
"value": "BATHROOM"
}
]
patch
Path Parameters
classifiedIdstring(uuid)required
ID of classified to update
>= 1 characters
mediaIdstring(uuid)required
ID of the media to update
>= 1 characters
Headers
traceparentstring
Identifies the incoming request in the tracing system
Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01
User-Agentstringrequired
Characteristic string that identifies the application, operating system, vendor, and version of the requesting user agent.
Syntax : User-Agent: <crm-software-name>/<crm-software-version> <tool-name>/<tool-version> <operating-system>/<operating-system-version>
All subset parts of this string do not allow the following characters : / and (whitespace)
Match pattern:^[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+$
Example:MyAwesomeSoft/1.0.0 curl/7.52.1 debian/9~1.gbpf8534c
authorizationstringrequired
Bearer token to authenticate request
Example:Bearer <token>
Body
application/json-patch+json
Body
application/json-patch+json
MediaPatch
MediaPatcharray
One Ofopstringrequired
The operation to be applied on the given JSON-Pointer
Allowed values:add
pathstringrequired
The JSON-Pointer
Allowed values:/title
Match pattern:(/(([^/~])|(~[01]))*)
valuestringrequired
media title, should be SEO optimized and describe the media content
Match pattern:(?!(^\s+$))^.+$
Example:Double living room
Response
application/json
Response
application/json
Accepted
mediaIdstring(uuid)
The unique identifier of a classified media
Example:122739e5-b8b7-4220-b3f7-a71151d81c6e
linksarray
Show Child Parameters
patch/classifieds/{classifiedId}/media/{mediaId}
Authentication
Path Parameters
Headers
Body
[
{}
]
application/json
Detach a media from the classified.
Detach a media from the classified
delete
Path Parameters
classifiedIdstring(uuid)required
ID of classified to update
>= 1 characters
mediaIdstring(uuid)required
ID of the media to delete
>= 1 characters
Headers
traceparentstring
Identifies the incoming request in the tracing system
Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01
User-Agentstringrequired
Characteristic string that identifies the application, operating system, vendor, and version of the requesting user agent.
Syntax : User-Agent: <crm-software-name>/<crm-software-version> <tool-name>/<tool-version> <operating-system>/<operating-system-version>
All subset parts of this string do not allow the following characters : / and (whitespace)
Match pattern:^[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+$
Example:MyAwesomeSoft/1.0.0 curl/7.52.1 debian/9~1.gbpf8534c
authorizationstringrequired
Bearer token to authenticate request
Example:Bearer <token>
Response
application/json
Response
application/json
Accepted
mediaIdstring(uuid)
Example:5c597a63-6932-4b0c-a2a0-2fd935be1755
linksarray
Show Child Parameters
delete/classifieds/{classifiedId}/media/{mediaId}
Authentication
Path Parameters
Headers
application/json
Status
Tracking the classifieds processing. This can be usefull in case of troubleshooting.
Get the statuses of a classified by its id.
Returns a classified status.
Hereafter the possible values currently supported for the classifieds status and the meaning of each possible values. Some of them can expect an action from your side (“Action required” with a boolean value).
| Status | Sub-status | Description | Action required |
|---|---|---|---|
| RECEIVING | RECEIVING_POST | The classified has successfully been received in our system. | No |
| RECEIVED | RECEIVED_POST | The classified has successfully been transmitted to the next steps. | No |
| RECEIVING_FAILED | RECEIVING_FAILED_POST | An error occurred while processing your classified. The classified has not been transmitted to the next steps. Please contact our technical support manager. | No |
| RECEIVING | RECEIVING_PUT | The classified update has successfully been received in our system. | No |
| RECEIVED | RECEIVED_PUT | The classified update has successfully been transmitted to the next steps. | No |
| RECEIVING_FAILED | RECEIVING_FAILED_PUT | An error occurred while processing your classified. The classified has not been transmitted to the next steps. Please contact our technical support manager. | No |
| RECEIVING | RECEIVING_PATCH | The classified partial update has successfully been received in our system. | No |
| RECEIVED | RECEIVING_PATCH | The classified partial update has successfully been transmitted to the next steps. | No |
| RECEIVING_FAILED | RECEIVING_FAILED_PATCH | An error occurred while processing your classified. The classified has not been transmitted to the next steps. Please contact our technical support manager. | No |
| RECEIVING | RECEIVING_DELETE | The classified deletion has successfully been received in our system. | No |
| RECEIVED | RECEIVED_DELETE | The classified deletion has successfully been transmitted to the next steps. | No |
| RECEIVING_FAILED | RECEIVING_FAILED_DELETE | An error occurred while processing your classified. The classified has not been transmitted to the next steps. Please contact our technical support manager. | No |
| CREATING | The classified is beeing created in our system. | No | |
| CREATED | The classified has successfully been created in our system. | No | |
| CREATING_FAILED | An error occurred while creating the classified in our system. | No | |
| UPDATING | The classified is beeing updated in our system. | No | |
| UPDATED | The classified has successfully been updated in our system. | No | |
| UPDATING_FAILED | An error occurred while updating the classified in our system. | No | |
| DELETING | The classified is beeing deleted in our system. | No | |
| DELETED | The classified has successfully been deleted in our system. | No | |
| DELETING_FAILED | An error occurred while deleting the classified in our system. | No |
get
Query Parameters
currentstring
Get the latest status of a classified
filterstring
Get the latest status of a classified
Allowed values:latest
statusarray[string]
Get a specific status of a classified
Allowed values:RECEIVEDRECEIVINGRECEIVING_FAILEDCREATINGCREATEDCREATING_FAILEDUPDATINGUPDATEDUPDATING_FAILEDDELETINGDELETEDDELETING_FAILED
portalarray[string]
Portals where the classified is published
Allowed values:SLBUCOMBDLRLISLCSLN
limitinteger
Limit the number of results to be returned
nextTokenstring
Use this value to start a new operation, excluding this value in the new request.
Path Parameters
classifiedIdstringrequired
ID of classified to return
>= 1 characters
Headers
traceparentstring
Identifies the incoming request in the tracing system
Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01
User-Agentstringrequired
Characteristic string that identifies the application, operating system, vendor, and version of the requesting user agent.
Syntax : User-Agent: <crm-software-name>/<crm-software-version> <tool-name>/<tool-version> <operating-system>/<operating-system-version>
All subset parts of this string do not allow the following characters : / and (whitespace)
Match pattern:^[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+$
Example:MyAwesomeSoft/1.0.0 curl/7.52.1 debian/9~1.gbpf8534c
authorizationstringrequired
Bearer token to authenticate request
Example:Bearer <token>
Response
application/json
Response
application/json
successful operation
itemsarrayrequired
Show Child Parameters
nextTokenstring
Example:eyJzdGF0dXNEYXRlIjoiMjAyMC0wNy0yOVQxMjozMTowNy24MjRaIiwic3RhdHVzSWQiOiIwZWZjMWRhZC1lODg4LTRlMDEtODcxZi0zYTgyNDQxM2EzYjEiLCJjbGFzc2lmaWVkSWQiOiIwNGRkOWYxZS0zYTY2LTQ4MDQtYjFjMy03NTY2NmJiMjhhYWEifQ==
get/classifieds/{classifiedId}/statuses
Authentication
Path Parameters
Query Parameters
Headers
application/json