Skip to content

Latest commit

 

History

History
85 lines (58 loc) · 2.43 KB

File metadata and controls

85 lines (58 loc) · 2.43 KB

Org Invites Actions

Details on the various actions that can be performed on the Org Invites resource, including the expected parameters and the potential responses.

Contents

Get

Gets information about an invite

result = client.org_invites.get(
    token=my_token,
    email=my_email)

print(result)

Authentication

No api access token is required to call this action.

Available Parameters

Name Type Required Description Default Example
token string Y The token associated with the invite aTokenString
email string Y The email associated with the invite example@example.com
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Organization Invitation Information Information about invite

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if invite not found
410 Error Error if invite has expired

Post

Accepts/Rejects an invite

result = client.org_invites.post(invite=my_invite)

print(result)

Authentication

No api access token is required to call this action.

Available Parameters

Name Type Required Description Default Example
invite Organization Invitation Action Y Invite info and acceptance Organization Invitation Action Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Organization Invitation Result Acceptance/Rejection of invite

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if invite not found
410 Error Error if invite has expired