Accepts an invitation using its invitation code.

POSThttps://api.awork.com/api/v1/invitations/accept

Authentication

AuthorizationBearer

Send your token in the Authorization: Bearer <token> header. See Authentication for API keys and OAuth.

Request body Required

The invitation code and optional referral code.

application/json

invitationCodestring or nullOptional

The invitation code provided when creating the invitation.

referralCodestring or nullOptional

The referral code provided when creating the invitation from a referral.

Responses

200 OK

204 No Content

400 Bad Request

application/json

codestringRequired

minLength: 1

The error code.

descriptionstringRequired

minLength: 1

The description of the error.

linkstringRequired

minLength: 1

The link to the API documentation page.

detailsarray of string or nullOptional

A list of details describing the error.

validationErrorsarray of object or nullOptional

If a validation error occurred, this contains the validation errors for each property.

Show 2 properties

propertystring or nullOptional

The name of the property that failed validation.

messagestring or nullOptional

The reason why this property failed validation.

traceIdstring or nullOptional

The request trace id for tracking the request.

curl -X POST --globoff 'https://api.awork.com/api/v1/invitations/accept' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  --data '{
  "invitationCode": "a368cfdb4=",
  "referralCode": "cdf989ff="
}'

{
  "invitationCode": "a368cfdb4=",
  "referralCode": "cdf989ff="
}