Segment Export

Find Segment

Obtains the customers of a previously scheduled segment

GET https://api.woowup.com/apiv3/export/segments/{id}

Use last_update attribute to check if segment was updated

Headers

Name	Type	Description
Authorization*	String	Basic {{API-KEY}}
Content-Type*	String	application/json
Accept*	String	application/json

200: OK

{
    "payload": {
        "segment": {
            "id": 1,
            "title": "test",
            "url": "https://example.com",
            "last_update": "YYYY-MM-DD HH:mm:ss"
        }
    },
    "message": "",
    "code": "ok",
    "time": "1ms"
}

404: Not Found

{
    "payload": [],
    "message": "The segment does not exist | The segment is not available for download at this time, please try again in 24 hours.",
    "code": "not_found",
    "time": "45ms"
}

400: Bad Request

{
    "payload": [],
    "message": "parameters required",
    "code": "client_error",
    "time": "45ms"
}

500: Internal Server Error

{
    "payload": [],
    "message": "something happened",
    "code": "server_error",
    "time": "45ms"
}

Schedule Segment

The export will be updated daily with clients who meet the conditions of the segment

POST https://api.woowup.com/apiv3/export/segments/{id}

Headers

Name	Type	Description
Authorization	String	Basic {{API-KEY}}
Content-Type	String	application/json
Accept	String	application/json

200: OK

{
    "payload": [],
    "message": "Scheduled segment, in 24 hs the segment is going to be ready to export",
    "code": "ok",
    "time": "17ms"
}

400: Bad Request

{
    "payload": [],
    "message": "Export already scheduled",
    "code": "client_error",
    "time": "19ms"
}

500: Internal Server Error

{
    "payload": [],
    "message": "something happened",
    "code": "server_error",
    "time": "45ms"
}

404: Not Found

{
    "payload": [],
    "message": "The segment does not exist",
    "code": "not_found",
    "time": "13ms"
}

Unschedule Segment

The export will stop updating and will no longer be available

DELETE https://api.woowup.com/apiv3/export/segments/{id}

Headers

Name	Type	Description
Authorization	String	Basic {{API-KEY}}
Content-Type	String	application/json
Accept	String	application/json

200: OK

{
    "payload": [],
    "message": "Unscheduled segment",
    "code": "ok",
    "time": "21ms"
}

500: Internal Server Error

{
    "payload": [],
    "message": "something happened",
    "code": "server_error",
    "time": "45ms"
}

404: Not Found

{
    "payload": [],
    "message": "The segment does not exist",
    "code": "not_found",
    "time": "13ms"
}