Create Special Offer

This API operation creates a DirectCam special offer for the user. The user will be obliged to perform for the duration when a member has bought the Special Offer.

URL / Endpoint

Need help with Postman?

POST /v1/DirectCam/CreateDirectCamSpecialOffer

POST /v1/Groups/DirectCam/CreateDirectCamSpecialOffer (See Group manager)

Request

Property	Type	Description
`OfferNumber`	integer	When supplied this number will be shown to the user in JustCamIt when someone enters a paid for mode having bought one of your offers. The minimum value is `1`. Note: When not supplied it will have the value of the currently highest number plus one.
`CurrentlyAvailable`	boolean	Required. If the user cannot currently provide a special offer or if needs preparation or prior agreement, set it to false to prevent members from purchasing it.
`Title`	string	Required. The maximum length is 50 characters.
`Duration`	integer	Required. The duration in minutes. The minimum value is `5`.
`TotalCredits`	decimal	Required. This total amount of credits for this Special Offer. The minimum value is `5`. Note: The Price Per Minute will be calculated using the `TotalCredits` and `Duration` (TotalCredits / Duration), this has a minimum of `0.6` credits.
`ModeID`	integer	Required. The mode of the DirectCam special offer in which the session will be conducted in. Possible values are `2` or `3` for In Group Chat or In Private respectively.
`AllowRateContinue`	boolean	When set to `true` any session based on this offer will be allowed to continue past the offer duration at the offer price per minute. When set to `false` the member will be disconnected when the offer duration is reached.

Group manager

If the authenticated user is the manager of a group, the user can impersonate another member of the group. This allows the manager to perform tasks of other group members without having to authenticate as them.

The request can be build in the same way as the regular request, but targeted towards the Group manager endpoint. Additionally, it has the following extra parameters:

Property	Type	Description
`UserID`	integer	Required. The ID of a member in the group that will be impersonated for this request.

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP POST method with serialized JSON in the request body.

Headers

The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.

Authentication

An Authorization header is required with every request and must contain the access_token of the user. More information can be found in the Access tokens page.

Scopes

This endpoint requires the following scope:

Scope
`account_webcam_bookings`

Samples

POST method

https://api-sandbox.adultwork.com/v1/DirectCam/CreateDirectCamSpecialOffer
Authorization: bearer {your-access-token}
{
    "OfferNumber" : 1,
    "CurrentlyAvailable" : true,
    "Title": "Lollipop show",
    "Duration" : 10,
    "TotalCredits": 8,
    "ModeID" : 2,
    "AllowRateContinue" : true
}

POST as Group manager

https://api-sandbox.adultwork.com/v1/Groups/DirectCam/CreateDirectCamSpecialOffer
Authorization: bearer {your-access-token}
{
    "UserID" : 123456,
    "OfferNumber" : 1,
    "CurrentlyAvailable" : true,
    "Title": "Lollipop show",
    "Duration" : 10,
    "TotalCredits": 8,
    "ModeID" : 2,
    "AllowRateContinue" : true
}

Response

Property	Type	Description
`OfferID`	integer	ID of the direct cam special offer.
`OfferNumber`	integer	The number of the direct cam special offer.
`Title`	string	The title of the direct cam special offer.
`Duration`	integer	Duration in minutes of the direct cam special offer.
`ModeID`	integer	The mode of the DirectCam special offer in which the session will be conducted in. Possible values are `2` or `3` for In Group Chat or In Private respectively.
`DoesPrivate`	boolean	If set to `true` the member allows pay-per-minute Private one-to-one mode.
`PrivatePPM`	decimal	The price per minute (in Credits) of a DirectCam Private one-to-one session.
`DoesGroup`	boolean	If set to `true` the member allows pay-per-minute Group Chat mode.
`GroupPPM`	decimal	The price per minute (in Credits) of a DirectCam Group Chat session.
`TotalPrice`	decimal	The total price (in Credits) of a DirectCam session for the special offer.
`AllowRateContinue`	boolean	If set to `true` the length of the session is not limited to to the duration of the special offer. The session will continue using the PrivatePPM or GroupPPM depending on the offering mode of the member.
`Incomplete`	boolean	If set to `true` the special offer session is not completed and can be resumed without additional costs.
`CanPurchase`	boolean	If set to `true` the special offer is available for purchase.

Response Sample

The following example returns a successfully created Special Offer.

JSON
XML

{
    "OfferID": 1,
    "OfferNumber": 1,
    "Title": "Lollipop show",
    "Duration": 10,
    "PrivatePPM": "1.25",
    "TotalPrice": "8.00",
    "AllowRateContinue": true,
    "ModeID": 2,
    "Incomplete": true,
    "CanPurchase": true,
    "GroupPPM": "1.00",
    "DoesGroup": true,
    "DoesPrivate": true
}

<DirectCamSpecialOffer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.DirectCam">
    <AllowRateContinue>true</AllowRateContinue>
    <CanPurchase>true</CanPurchase>
    <DoesGroup>true</DoesGroup>
    <DoesPrivate>true</DoesPrivate>
    <Duration>10</Duration>
    <GroupPPM>1.00</GroupPPM>
    <Incomplete>true</Incomplete>
    <ModeID>2</ModeID>
    <OfferID>1</OfferID>
    <OfferNumber>1</OfferNumber>
    <PrivatePPM>1.25</PrivatePPM>
    <Title>Lollipop show</Title>
    <TotalPrice>8.00</TotalPrice>
</DirectCamSpecialOffer>