UNunipile
Users

Send an invitation

Changed on

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

post/api/v1/users/invite

Request

Request body

provider_idstring required

The id of the user to add. It has to be the provider’s id. LinkedIn Classic: inviting the connected account's own profile returns HTTP 422 (errors/cannot_invite_attendee). <br> Instagram: You can use the provider_id or the username of the user. The provider_messaging_id dont work on this route !

account_idstring required

The id of the account where the user will be added.

user_emailstring emailLike

The email address of the user when it's required (Linkedin specific).

messagestring

An optional message to go with the invitation (max 300 chars).

Response

OK. Request succeeded.

object'UserInvitationSent' required
invitation_idstring required
usagenumber

A percentage of query usage based on the limit set by the provider. Triggers only on passing a new landing (50, 75, 90, 95).

Changes

  • e74f29ca2aaaRevision changes
    • warning

      added the new errors/connection_limit_reached enum value to the response property for the response status

    • warning

      added the new errors/not_supported_by_provider enum value to the response property for the response status

    • warning

      added the new errors/password_reset_required enum value to the response property for the response status

    • warning

      added the new errors/target_audience_too_small enum value to the response property for the response status

    • info

      added the optional property to the response with the status