Skip to content
Wink

Invite

POST
/api/managing-entity/{managingEntityIdentifier}/extranet/sales/affiliate/invite
 
curl --request POST \
  --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/sales/affiliate/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data null

Email an invitation asking a user to become an affiliate of the given account.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Managing entity identifier (UUID)

Example 
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Request Body required

Section titled “Request Body required ”

Affiliate invitation details including the invitee email address and optional message

Media type application/json

Request to send an affiliate invitation email, linking a property to an affiliate partner.

object
hotelEmail
required

The email of the property

string format: email
"" >= 1 characters
Example 
[email protected]
affiliateEmail
required

The email of the affiliate

string format: email
"" >= 1 characters
Example 
[email protected]
affiliateName
required

The name of the affiliate

string
"" >= 1 characters
Example 
Global Travel Agency
Example 
{
  "hotelEmail": "[email protected]",
  "affiliateEmail": "[email protected]",
  "affiliateName": "Global Travel Agency"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Whether the invitation was sent successfully

Media type application/json

Standard immutable response wrapper that returns a success/failure indicator with an optional message.

object
success

Whether call to endpoint was successful or not.

boolean
message

A message indicating more textual information. Mostly used to convey an error message.

string
""
key
additional properties
""
Example 
{
  "success": true,
  "message": "User has permission to access this resource"
}

400

Section titled “400 ”

Bad Request — missing or invalid request parameter or body

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

401

Section titled “401 ”

Unauthorized — authentication is required or the session has expired

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

403

Section titled “403 ”

Forbidden — authenticated but lacking the required permission or scope

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

404

Section titled “404 ”

Not Found — the requested resource does not exist

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

405

Section titled “405 ”

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

415

Section titled “415 ”

Unsupported Media Type — use application/json

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

500

Section titled “500 ”

Internal Server Error — an unexpected failure occurred on the server

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

503

Section titled “503 ”

Service Unavailable — a downstream dependency is unreachable

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example