> ## Documentation Index > Fetch the complete documentation index at: https://docs.apollodeploy.com/llms.txt > Use this file to discover all available pages before exploring further. # Upload contact profile image > Uploads a profile image file (multipart/form-data, field name `file`) to S3 and stores the resulting URL on the contact. Accepted types: jpeg, png, webp, gif. Max size: 5 MiB. ### Requirements - **Permission:** `contacts:write`. - **Project access:** the path project must match the API key's project. - **HTTP rate limit:** 200 requests per 60 seconds per API key. ## OpenAPI ````yaml /signal/api-reference/openapi.json post /v1/projects/{projectId}/contacts/{contactId}/image openapi: 3.1.0 info: title: Apollo Signal API version: 1.0.0 description: >- Public REST API for transactional email, contacts, audiences, webhooks, metrics, projects, and sending domains. servers: - url: https://api.signal.apollodeploy.com description: Production security: [] tags: - name: Emails description: Send, inspect, cancel, validate, and stream transactional email activity. - name: Metrics description: Read project, topic, message, and deliverability analytics. - name: Suppressions description: Manage addresses that Apollo Signal must not send to. - name: Segments description: Create dynamic contact groups and inspect their membership. - name: Topics description: Manage subscription topics and topic membership. - name: Contact properties description: Define the custom fields available on project contacts. - name: Contacts description: >- Manage contacts, audience membership, images, activity, and engagement data. - name: Webhooks description: Manage webhook endpoints, deliveries, tests, and replays. - name: API key usage description: Inspect API key metadata and request usage without exposing raw keys. - name: Projects description: Inspect projects and project-scoped email logs. - name: Sending domains description: >- Register, verify, inspect, and remove sending domains and BIMI configuration. paths: /v1/projects/{projectId}/contacts/{contactId}/image: post: tags: - Contacts summary: Upload contact profile image description: >- Uploads a profile image file (multipart/form-data, field name `file`) to S3 and stores the resulting URL on the contact. Accepted types: jpeg, png, webp, gif. Max size: 5 MiB. ### Requirements - **Permission:** `contacts:write`. - **Project access:** the path project must match the API key's project. - **HTTP rate limit:** 200 requests per 60 seconds per API key. operationId: uploadContactImage parameters: - name: projectId in: path required: true deprecated: false explode: false schema: type: string title: String description: >- Project identifier. For API-key authentication, it must match the project bound to the key. - name: contactId in: path required: true deprecated: false explode: false schema: type: string title: String description: Contact identifier in this project. requestBody: description: >- Multipart form containing exactly one profile image in the `file` field. The file must be JPEG, PNG, WebP, or GIF and no larger than 5 MiB. required: true content: multipart/form-data: schema: type: object required: - file properties: file: type: string format: binary description: JPEG, PNG, WebP, or GIF profile image, up to 5 MiB. responses: '200': description: Image uploaded; returns updated contact. headers: {} content: application/json: schema: $ref: >- #/components/schemas/com.apollodeploy.signal.feature.contact.api.model.ContactResponse '400': headers: {} content: application/problem+json: schema: $ref: >- #/components/schemas/com.apollodeploy.commons.core.error.ApiProblem description: The request is malformed or contains invalid input. '401': headers: {} content: application/problem+json: schema: $ref: >- #/components/schemas/com.apollodeploy.commons.core.error.ApiProblem description: >- The API key or stream token is missing, invalid, expired, or inactive. '403': description: >- The credential lacks the required permission or cannot access this project. headers: {} content: application/problem+json: schema: $ref: >- #/components/schemas/com.apollodeploy.commons.core.error.ApiProblem '404': headers: {} content: application/problem+json: schema: $ref: >- #/components/schemas/com.apollodeploy.commons.core.error.ApiProblem description: The requested resource was not found in the authenticated project. '413': headers: {} content: application/problem+json: schema: $ref: >- #/components/schemas/com.apollodeploy.commons.core.error.ApiProblem description: The request or imported data exceeds the supported size. '429': description: >- The endpoint rate limit was exceeded. Wait for the `Retry-After` interval before retrying. headers: Retry-After: description: Whole seconds to wait before retrying. schema: type: integer minimum: 1 content: application/problem+json: schema: $ref: >- #/components/schemas/com.apollodeploy.commons.core.error.ApiProblem deprecated: false security: - bearerAuth: [] x-codeSamples: - lang: TypeScript label: TypeScript source: >- import { createApolloSignalApiClient } from "@apollo-deploy/signal-sdk"; const signal = createApolloSignalApiClient({ apiKey: "ap_signal_..." }); const result = await signal.contacts.uploadContactProfileImage(/* params */); console.log(result); - lang: Python label: Python source: |- from apollo_signal import SignalClient signal = SignalClient(api_key="ap_signal_...") result = signal.contacts.uploadContactProfileImage(# params) print(result) - lang: Go label: Go source: >- import signal "github.com/apollo-deploy/signal-sdk-go" client := signal.NewClient("ap_signal_...") result, err := client.Contacts.UploadContactProfileImage(context.Background() /* params */) if err != nil { log.Fatal(err) } fmt.Println(result) - lang: Java label: Java source: >- import com.apollodeploy.signal.SignalClient; SignalClient signal = new SignalClient("ap_signal_..."); var result = signal.contacts().uploadContactProfileImage(/* params */); System.out.println(result); - lang: Kotlin label: Kotlin source: |- import com.apollodeploy.signal.SignalClient val signal = SignalClient("ap_signal_...") val result = signal.contacts.uploadContactProfileImage(/* params */) println(result) - lang: Ruby label: Ruby source: |- require "apollo_signal" signal = ApolloSignal::Client.new(api_key: "ap_signal_...") result = signal.contacts.uploadContactProfileImage(# params) puts result - lang: PHP label: PHP source: >- use ApolloSignal\SignalClient; $signal = new SignalClient("ap_signal_..."); $result = $signal->contacts->uploadContactProfileImage(/* params */); var_dump($result); - lang: Rust label: Rust source: >- use apollo_signal::SignalClient; let signal = SignalClient::new("ap_signal_..."); let result = signal.contacts.uploadContactProfileImage(/* params */).await?; println!("{:?}", result); - lang: C# label: .NET source: >- using ApolloSignal; var signal = new SignalClient("ap_signal_..."); var result = await signal.Contacts.UploadContactProfileImageAsync(/* params */); Console.WriteLine(result); components: schemas: com.apollodeploy.signal.feature.contact.api.model.ContactResponse: type: object properties: createdAt: type: string title: String email: type: string title: String firstName: type: string title: String id: type: string title: String lastName: type: string title: String object: type: string title: String phone: type: string title: String profileImageUrl: type: string title: String projectId: type: string title: String properties: type: object additionalProperties: type: string title: String title: Map segments: type: array items: type: string title: String title: List topics: type: array items: $ref: >- #/components/schemas/com.apollodeploy.signal.feature.contact.api.model.TopicSubscriptionResponse title: List unsubscribed: type: boolean title: Boolean updatedAt: type: string title: String required: - createdAt - email - id - object - projectId - properties - segments - topics - unsubscribed - updatedAt title: ContactResponse com.apollodeploy.commons.core.error.ApiProblem: type: object properties: code: type: string title: ErrorCode detail: type: string title: String errors: type: array items: $ref: >- #/components/schemas/com.apollodeploy.commons.core.error.FieldProblem title: List instance: type: string title: ProblemInstance requestId: type: string title: String status: type: integer format: int32 title: Int title: type: string title: String type: type: string title: ProblemType required: - code - status - title - type title: ApiProblem com.apollodeploy.signal.feature.contact.api.model.TopicSubscriptionResponse: type: object properties: subscription: type: string title: String topicId: type: string title: String required: - subscription - topicId title: TopicSubscriptionResponse com.apollodeploy.commons.core.error.FieldProblem: type: object properties: detail: type: string title: String pointer: type: string title: String required: - detail - pointer title: FieldProblem securitySchemes: bearerAuth: type: http scheme: bearer description: >- Project-bound Apollo Signal API key. Keys begin with `ap_signal_` and must carry the permission shown on the operation. ````