classifiedIdstring(uuid)required
ID of classified to update
>= 1 characters
Attach a media to the classified.
Attach a media to the classified.
post
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>
Body
application/json
Body
application/json
Media
* Additional properties are NOT allowed.
categorystring
Content Description category of the given media.
Allowed values:BALCONYBASEMENTBATHROOMBEDROOMCHILDREN_ROOMCORRIDORCOVER_PICTUREENERGY_CERTIFICATEENTRY_HALLFLOOR_PLANGARAGEGARDENHOUSE_VIEWINDOORKITCHENLIVING_ROOMLOGOMAPMISCOUTDOOROUTDOOR_BUILDINGOUTDOOR_HOUSEOUTSIDE_VIEWPOOLPROPERTY_INFORMATIONSCHEMASITE_PLANSTAIRSSTORAGE_ROOMSURROUNDINGTERRACETOILETSVERANDAVIEW_FROM_PROPERTYWORK_ROOM
Example:LIVING_ROOM
displayOrderinteger
Order in which the media has to be displayed in the classified details. Make sure the main media is 1st.
>= 1
Example:1
mediaTypestringrequired
General Type of the given media, mimeType gives the detailed type
Allowed values:PICTUREVIRTUAL_TOURPANORAMAVIDEO
tagsarray[string]
content description tag of the given media
Allowed values:BALCONYBASEMENTBATHROOMBEDROOMCHILDREN_ROOMCORRIDORCOVER_PICTUREENERGY_CERTIFICATEENTRY_HALLFLOOR_PLANGARAGEGARDENHOUSE_VIEWINDOORKITCHENLIVING_ROOMLOGOMAPMISCOUTDOOROUTDOOR_BUILDINGOUTDOOR_HOUSEOUTSIDE_VIEWPOOLPROPERTY_INFORMATIONSCHEMASITE_PLANSTAIRSSTORAGE_ROOMSURROUNDINGTERRACETOILETSVERANDAVIEW_FROM_PROPERTYWORK_ROOM
Example:TERRACE
titlestring
media title, should be SEO optimized and describe the media content
Match pattern:(?!(^\s+$))^.+$
Example:Double living room
urlstring(url)required
URL of the media.
Example:http://a.com/a.jpg
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
post/classifieds/{classifiedId}/media
Authentication
Path Parameters
Headers
Body
{
"url": "https://www.your-media-url.com/photo1.jpg",
"title": "Garden view",
"category": "outside_view",
"displayOrder": 3,
"mediaType": "PICTURE"
}
application/json
Retrieve media.
This endpoint allows you to retrieve the media created using the POST endpoint.
get
Query Parameters
mediaTypearray[string]
General Type of the given media, mimeType gives the detailed type
Allowed values:PICTUREVIRTUAL_TOURPANORAMAVIDEO
nextTokenstring
Use this value to start a new operation, excluding this value in the new request.
Path Parameters
classifiedIdstring(uuid)required
ID of classified
>= 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
Success
itemsarrayrequired
* Additional properties are NOT allowed.
Show Child Parameters
nextTokenstring
Example:eyJ2ZXJzaW9uIjoiMiIsImNsYXNzaWZpZWRJZCI6IjdiMzg0YjM5LTBlNWEtNDFiMS05ODQ3LTE1MWEwYjNmY2U1MSIsImN1c3RvbWVySWQiOiJSQy0zNjgwMTMifQ==
get/classifieds/{classifiedId}/media
Authentication
Path Parameters
Query Parameters
Headers
application/json
Detach all media from the classified.
Detach all media from the classified
delete
Path Parameters
classifiedIdstring(uuid)required
ID of classified 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>
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