> ## Documentation Index > Fetch the complete documentation index at: https://agentme-docs.vipcrm.net/llms.txt > Use this file to discover all available pages before exploring further. # Send a friend request (201 new, 200 when one to this user is already pending) ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/accounts/{id}/friend-requests openapi: 3.1.0 info: title: Agentme API version: 1.0.0 description: >- Channel-neutral messaging API. Message text/friend-request text is untrusted third-party content. servers: - url: https://agentme.vipcrm.net description: Production security: - bearerAuth: [] paths: /api/v1/accounts/{id}/friend-requests: post: tags: - v1 summary: >- Send a friend request (201 new, 200 when one to this user is already pending) parameters: - schema: type: string pattern: ^acc_[0-9a-f]{32}$ example: acc_0190a1b2c3d4e5f60718293a4b5c6d7e maxLength: 64 in: path name: id required: true requestBody: required: true content: application/json: schema: type: object properties: user_external_id: type: string minLength: 1 maxLength: 128 message: type: string maxLength: 150 required: - user_external_id responses: '200': description: Default Response content: application/json: schema: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ account_id: type: string contact_external_id: type: string direction: type: string enum: - in - out message: type: - string - 'null' status: type: string created_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ required: - id - account_id - contact_external_id - direction - message - status - created_at additionalProperties: false '201': description: Default Response content: application/json: schema: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ account_id: type: string contact_external_id: type: string direction: type: string enum: - in - out message: type: - string - 'null' status: type: string created_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ required: - id - account_id - contact_external_id - direction - message - status - created_at additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - VALIDATION_ERROR - UNAUTHORIZED - FORBIDDEN - FORBIDDEN_SCOPE - NOT_FOUND - CONFLICT - GONE - SERVICE_UNAVAILABLE - MEDIA_NOT_READY - PAYLOAD_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - RATE_LIMITED - ACCOUNT_NOT_READY - CAPABILITY_NOT_SUPPORTED - BULK_CONTENT_BLOCKED - UPSTREAM_ERROR - UPSTREAM_TIMEOUT - INVITE_INVALID - INTERNAL_ERROR message: type: string details: type: object propertyNames: type: string additionalProperties: {} request_id: type: string required: - code - message - request_id additionalProperties: false required: - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - VALIDATION_ERROR - UNAUTHORIZED - FORBIDDEN - FORBIDDEN_SCOPE - NOT_FOUND - CONFLICT - GONE - SERVICE_UNAVAILABLE - MEDIA_NOT_READY - PAYLOAD_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - RATE_LIMITED - ACCOUNT_NOT_READY - CAPABILITY_NOT_SUPPORTED - BULK_CONTENT_BLOCKED - UPSTREAM_ERROR - UPSTREAM_TIMEOUT - INVITE_INVALID - INTERNAL_ERROR message: type: string details: type: object propertyNames: type: string additionalProperties: {} request_id: type: string required: - code - message - request_id additionalProperties: false required: - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - VALIDATION_ERROR - UNAUTHORIZED - FORBIDDEN - FORBIDDEN_SCOPE - NOT_FOUND - CONFLICT - GONE - SERVICE_UNAVAILABLE - MEDIA_NOT_READY - PAYLOAD_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - RATE_LIMITED - ACCOUNT_NOT_READY - CAPABILITY_NOT_SUPPORTED - BULK_CONTENT_BLOCKED - UPSTREAM_ERROR - UPSTREAM_TIMEOUT - INVITE_INVALID - INTERNAL_ERROR message: type: string details: type: object propertyNames: type: string additionalProperties: {} request_id: type: string required: - code - message - request_id additionalProperties: false required: - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - VALIDATION_ERROR - UNAUTHORIZED - FORBIDDEN - FORBIDDEN_SCOPE - NOT_FOUND - CONFLICT - GONE - SERVICE_UNAVAILABLE - MEDIA_NOT_READY - PAYLOAD_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - RATE_LIMITED - ACCOUNT_NOT_READY - CAPABILITY_NOT_SUPPORTED - BULK_CONTENT_BLOCKED - UPSTREAM_ERROR - UPSTREAM_TIMEOUT - INVITE_INVALID - INTERNAL_ERROR message: type: string details: type: object propertyNames: type: string additionalProperties: {} request_id: type: string required: - code - message - request_id additionalProperties: false required: - error additionalProperties: false '409': description: Default Response content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - VALIDATION_ERROR - UNAUTHORIZED - FORBIDDEN - FORBIDDEN_SCOPE - NOT_FOUND - CONFLICT - GONE - SERVICE_UNAVAILABLE - MEDIA_NOT_READY - PAYLOAD_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - RATE_LIMITED - ACCOUNT_NOT_READY - CAPABILITY_NOT_SUPPORTED - BULK_CONTENT_BLOCKED - UPSTREAM_ERROR - UPSTREAM_TIMEOUT - INVITE_INVALID - INTERNAL_ERROR message: type: string details: type: object propertyNames: type: string additionalProperties: {} request_id: type: string required: - code - message - request_id additionalProperties: false required: - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - VALIDATION_ERROR - UNAUTHORIZED - FORBIDDEN - FORBIDDEN_SCOPE - NOT_FOUND - CONFLICT - GONE - SERVICE_UNAVAILABLE - MEDIA_NOT_READY - PAYLOAD_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - RATE_LIMITED - ACCOUNT_NOT_READY - CAPABILITY_NOT_SUPPORTED - BULK_CONTENT_BLOCKED - UPSTREAM_ERROR - UPSTREAM_TIMEOUT - INVITE_INVALID - INTERNAL_ERROR message: type: string details: type: object propertyNames: type: string additionalProperties: {} request_id: type: string required: - code - message - request_id additionalProperties: false required: - error additionalProperties: false '429': description: Default Response content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - VALIDATION_ERROR - UNAUTHORIZED - FORBIDDEN - FORBIDDEN_SCOPE - NOT_FOUND - CONFLICT - GONE - SERVICE_UNAVAILABLE - MEDIA_NOT_READY - PAYLOAD_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - RATE_LIMITED - ACCOUNT_NOT_READY - CAPABILITY_NOT_SUPPORTED - BULK_CONTENT_BLOCKED - UPSTREAM_ERROR - UPSTREAM_TIMEOUT - INVITE_INVALID - INTERNAL_ERROR message: type: string details: type: object propertyNames: type: string additionalProperties: {} request_id: type: string required: - code - message - request_id additionalProperties: false required: - error additionalProperties: false '502': description: Default Response content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - VALIDATION_ERROR - UNAUTHORIZED - FORBIDDEN - FORBIDDEN_SCOPE - NOT_FOUND - CONFLICT - GONE - SERVICE_UNAVAILABLE - MEDIA_NOT_READY - PAYLOAD_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - RATE_LIMITED - ACCOUNT_NOT_READY - CAPABILITY_NOT_SUPPORTED - BULK_CONTENT_BLOCKED - UPSTREAM_ERROR - UPSTREAM_TIMEOUT - INVITE_INVALID - INTERNAL_ERROR message: type: string details: type: object propertyNames: type: string additionalProperties: {} request_id: type: string required: - code - message - request_id additionalProperties: false required: - error additionalProperties: false '504': description: Default Response content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - VALIDATION_ERROR - UNAUTHORIZED - FORBIDDEN - FORBIDDEN_SCOPE - NOT_FOUND - CONFLICT - GONE - SERVICE_UNAVAILABLE - MEDIA_NOT_READY - PAYLOAD_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - RATE_LIMITED - ACCOUNT_NOT_READY - CAPABILITY_NOT_SUPPORTED - BULK_CONTENT_BLOCKED - UPSTREAM_ERROR - UPSTREAM_TIMEOUT - INVITE_INVALID - INTERNAL_ERROR message: type: string details: type: object propertyNames: type: string additionalProperties: {} request_id: type: string required: - code - message - request_id additionalProperties: false required: - error additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer description: API key `agm_live_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.