Send an invitation

post

https://{subdomain}.unipile.com:{port}/api/v1/users/invite

Send an invitation to add someone to your contacts. Ensure careful implementation of this action and consult provider limits and restrictions: https://developer.unipile.com/docs/provider-limits-and-restrictions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

400

      ## Bad Request
      ### Too many characters
      The provided content exceeds the character limit.

undefined

401

      ## Unauthorized
      ### Disconnected account
      The account appears to be disconnected from the provider service.

undefined

403

      ## Forbidden
      ### Feature not subscribed
      The requested feature has either not been subscribed or not been authenticated properly.

undefined

422

      ## Unprocessable Entity
      ### Invalid account
      Provided account is not designed for this feature.

undefined

429

    ## Too Many Requests
    ### Too many requests
    The provider cannot accept any more requests at the moment. Please try again later.

undefined

501

    ## Not Implemented
    ### Missing feature
    Requested feature is planned but has not been implemented yet.

undefined

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Send an invitation

Not Found

Resource not found.

Internal Server Error

Unexpected error - Type: "errors/unexpected_error"

Provider error - Type: "errors/provider_error"

Authentication intent error - Type: "errors/authentication_intent_error"

Service Unavailable

No client session - Type: "errors/no_client_session"

No channel - Type: "errors/no_channel"

Handler missing - Type: "errors/no_handler"

Network down - Type: "errors/network_down"

Service unavailable - Type: "errors/service_unavailable"

Gateway Timeout

Request timed out - Type: "errors/request_timeout"

200OK. Request succeeded.

400 ## Bad Request ### Too many characters The provided content exceeds the character limit. undefined

401 ## Unauthorized ### Disconnected account The account appears to be disconnected from the provider service. undefined

403 ## Forbidden ### Feature not subscribed The requested feature has either not been subscribed or not been authenticated properly. undefined

404Not Found Resource not found. The requested resource were not found. Account not found

Not Found

Resource not found.

422 ## Unprocessable Entity ### Invalid account Provided account is not designed for this feature. undefined

429 ## Too Many Requests ### Too many requests The provider cannot accept any more requests at the moment. Please try again later. undefined

Internal Server Error

Unexpected error - Type: "errors/unexpected_error"

Provider error - Type: "errors/provider_error"

Authentication intent error - Type: "errors/authentication_intent_error"

501 ## Not Implemented ### Missing feature Requested feature is planned but has not been implemented yet. undefined

Service Unavailable

No client session - Type: "errors/no_client_session"

No channel - Type: "errors/no_channel"

Handler missing - Type: "errors/no_handler"

Network down - Type: "errors/network_down"

Service unavailable - Type: "errors/service_unavailable"

504Gateway Timeout Request timed out - Type: "errors/request_timeout" Request Timeout. Please try again, and if the issue persists, contact support.

Gateway Timeout

Request timed out - Type: "errors/request_timeout"