Claim Invite

Request URL

PUT /invite/claim/:linklink

Description

This API is called by a user who has received an invite to claim access to the account he/she has been invited to. The invite is represented by the path parameter linklink. This is a property of the invite object.

If the claim is successful, the user is given access to the account for the role specified and the invite object is replaced by an objectLink object.

Schema

Property table for invite/claim/:linklink

Property	Description	Required	Schema
linklink	Link that represents the invite	Yes	{   "type": "string" }

Snippet Examples

javascript

const axios = require('axios');
const config = {
  method: 'PUT',
  url: '${AMPLIFI_BASE_URL}/invite/claim/:linklink',
  headers: {
    'Content-Type': "application/json",
    'token': "A long random string token received from /token request"
  },
};

let result;
try {
  result = await axios.request(config);
  if (result.status === 200) {
    console.log(JSON.stringify(result.data));
  }
} catch (err) {
  console.log({
    errCode: err.code,
    responseStatus: err.response && err.response.status,
    data: err.response && JSON.stringify(err.response.data)
  });
}

cURL

curl --location "AMPLIFI_BASE_URL/invite/claim/:linklink"  --header "Content-Type: application/json" --header "token: A long random string token received from /token request" 

Successful Response Examples

200 INVITE/CLAIM/:LINKLINK SUCCESSFUL RESPONSE CLAIMING INVITE

HEADERS

Header	Value
Content-Type	application/json
token	A long random string token received from /token request

PARAMETERS

Parameter	Description	Value
linklink	[required]	AAORSLADF

REQUEST BODY

none

RESPONSE BODY

{
    "success": true,
    "AFiAccountId": "qwegal8kgtmysmels"
}