v1

latestOpenAPI 3.0.02026-07-249301.3 MB

Users

Send an invitation

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 body

provider_idstring required

The id of the user to add. It has to be the provider’s id. <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).