# Sender Profiles ## List sender profiles > Retrieve a list of sender profiles associated with the account ```json {"openapi":"3.0.3","info":{"title":"Collaboration","version":"v1"},"tags":[{"description":"Manage sender profiles","name":"sender_profile"}],"security":[{"user":[]},{"accessKey":[]}],"components":{"securitySchemes":{"user":{"description":"Provide the token that is returned upon login","scheme":"bearer","type":"http","bearerFormat":"jwt"},"accessKey":{"description":"Uses the Authorization header: 'AccessKey ' followed by your access key token","scheme":"AccessKey","type":"http"}},"parameters":{"pagination.param.limit":{"description":"Limits the number of results to return.","in":"query","name":"limit","schema":{"default":25,"maximum":100,"type":"integer"}},"pagination.param.pageToken":{"description":"The cursor that keeps track of the current position in the results.","in":"query","name":"pageToken","schema":{"type":"string"}},"pagination.param.reverse":{"description":"Reverses the order in which the results are returned.","in":"query","name":"reverse","schema":{"default":false,"type":"boolean"}}},"schemas":{"SenderProfileList":{"type":"object","required":["results"],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/SenderProfile"}}}},"SenderProfile":{"type":"object","additionalProperties":false,"required":["id","name","channelId","createdAt","updatedAt"],"properties":{"id":{"type":"string","maxLength":60},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/SenderProfileEmail"},"allowedEntities":{"type":"array","items":{"$ref":"#/components/schemas/SenderProfileAllowedEntity"}},"channelId":{"type":"string","maxLength":60},"signature":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"SenderProfileEmail":{"type":"object","additionalProperties":false,"required":["username","domain"],"properties":{"username":{"type":"string"},"domain":{"type":"string"}}},"SenderProfileAllowedEntity":{"type":"object","additionalProperties":false,"required":["entityType","entityId"],"properties":{"entityType":{"type":"string","enum":["team","agent"]},"operation":{"type":"string","enum":["view","edit"]},"entityId":{"type":"string","maxLength":60}}},"error.detailed":{"additionalProperties":false,"description":"An error returned from the API that includes additional details about the error. The `details` property can contain any additional information about the error that may be helpful for debugging or understanding the error.\n","properties":{"code":{"description":"A unique code that identifies the error. This code can be used to programmatically identify the error.","minLength":3,"type":"string"},"details":{"additionalProperties":true,"description":"Any additional information about the error that may be helpful for debugging or understanding the error.","type":"object"},"message":{"description":"A human-readable message that describes the error.","minLength":1,"type":"string"}},"required":["code","message"],"title":"DetailedError","type":"object"}},"responses":{"error.response.not_found":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.detailed"}}},"description":"The requested resource was not found."}}},"paths":{"/workspaces/{workspaceId}/sender-profiles":{"get":{"description":"Retrieve a list of sender profiles associated with the account","operationId":"listSenderProfiles","parameters":[{"$ref":"#/components/parameters/pagination.param.limit"},{"$ref":"#/components/parameters/pagination.param.pageToken"},{"$ref":"#/components/parameters/pagination.param.reverse"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SenderProfileList"}}},"description":"OK"},"404":{"$ref":"#/components/responses/error.response.not_found"}},"summary":"List sender profiles","tags":["sender_profile"]}}}} ``` ## Create new sender profile > Create a new sender profile, defining its name, and other attributes. ```json {"openapi":"3.0.3","info":{"title":"Collaboration","version":"v1"},"tags":[{"description":"Manage sender profiles","name":"sender_profile"}],"security":[{"user":[]},{"accessKey":[]}],"components":{"securitySchemes":{"user":{"description":"Provide the token that is returned upon login","scheme":"bearer","type":"http","bearerFormat":"jwt"},"accessKey":{"description":"Uses the Authorization header: 'AccessKey ' followed by your access key token","scheme":"AccessKey","type":"http"}},"schemas":{"CreateSenderProfile":{"type":"object","additionalProperties":false,"required":["name","channelId"],"properties":{"name":{"type":"string"},"username":{"type":"string"},"allowedEntities":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/SenderProfileAllowedEntity"}},"channelId":{"type":"string","maxLength":60},"signature":{"type":"string"}}},"SenderProfileAllowedEntity":{"type":"object","additionalProperties":false,"required":["entityType","entityId"],"properties":{"entityType":{"type":"string","enum":["team","agent"]},"operation":{"type":"string","enum":["view","edit"]},"entityId":{"type":"string","maxLength":60}}},"error.validation":{"additionalProperties":false,"description":"A validation error returned from the API. The `details` map keys are JSON paths\npointing into the request body / parameters; values are arrays of human-readable\nmessages describing each problem with that path.\n","properties":{"code":{"description":"A unique code that identifies the error. This code can be used to programmatically identify the error.","minLength":3,"type":"string"},"details":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Per-field validation messages keyed by JSON path.","type":"object"},"message":{"description":"A human-readable message that describes the error.","minLength":1,"type":"string"}},"required":["code","message"],"title":"ValidationError","type":"object"}},"responses":{"error.response.invalid_request":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.validation"}}},"description":"The request contains invalid parameters or body fields."}}},"paths":{"/workspaces/{workspaceId}/sender-profiles":{"post":{"description":"Create a new sender profile, defining its name, and other attributes.","operationId":"createSenderProfile","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSenderProfile"}}}},"responses":{"201":{"description":"created"},"422":{"$ref":"#/components/responses/error.response.invalid_request"}},"summary":"Create new sender profile","tags":["sender_profile"]}}}} ``` ## Get Sender profile > Retrieve information about a specific sender profile, including its name, and other attributes. ```json {"openapi":"3.0.3","info":{"title":"Collaboration","version":"v1"},"tags":[{"description":"Manage sender profiles","name":"sender_profile"}],"security":[{"user":[]},{"accessKey":[]}],"components":{"securitySchemes":{"user":{"description":"Provide the token that is returned upon login","scheme":"bearer","type":"http","bearerFormat":"jwt"},"accessKey":{"description":"Uses the Authorization header: 'AccessKey ' followed by your access key token","scheme":"AccessKey","type":"http"}},"schemas":{"SenderProfile":{"type":"object","additionalProperties":false,"required":["id","name","channelId","createdAt","updatedAt"],"properties":{"id":{"type":"string","maxLength":60},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/SenderProfileEmail"},"allowedEntities":{"type":"array","items":{"$ref":"#/components/schemas/SenderProfileAllowedEntity"}},"channelId":{"type":"string","maxLength":60},"signature":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"SenderProfileEmail":{"type":"object","additionalProperties":false,"required":["username","domain"],"properties":{"username":{"type":"string"},"domain":{"type":"string"}}},"SenderProfileAllowedEntity":{"type":"object","additionalProperties":false,"required":["entityType","entityId"],"properties":{"entityType":{"type":"string","enum":["team","agent"]},"operation":{"type":"string","enum":["view","edit"]},"entityId":{"type":"string","maxLength":60}}},"error.detailed":{"additionalProperties":false,"description":"An error returned from the API that includes additional details about the error. The `details` property can contain any additional information about the error that may be helpful for debugging or understanding the error.\n","properties":{"code":{"description":"A unique code that identifies the error. This code can be used to programmatically identify the error.","minLength":3,"type":"string"},"details":{"additionalProperties":true,"description":"Any additional information about the error that may be helpful for debugging or understanding the error.","type":"object"},"message":{"description":"A human-readable message that describes the error.","minLength":1,"type":"string"}},"required":["code","message"],"title":"DetailedError","type":"object"}},"responses":{"error.response.not_found":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.detailed"}}},"description":"The requested resource was not found."}}},"paths":{"/workspaces/{workspaceId}/sender-profiles/{senderProfileId}":{"get":{"description":"Retrieve information about a specific sender profile, including its name, and other attributes.","operationId":"getSenderProfile","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SenderProfile"}}},"description":"OK"},"404":{"$ref":"#/components/responses/error.response.not_found"}},"summary":"Get Sender profile","tags":["sender_profile"]}}}} ``` ## Update Sender profile > Modify the details of a specific sender profile, such as its name or other attributes. ```json {"openapi":"3.0.3","info":{"title":"Collaboration","version":"v1"},"tags":[{"description":"Manage sender profiles","name":"sender_profile"}],"security":[{"user":[]},{"accessKey":[]}],"components":{"securitySchemes":{"user":{"description":"Provide the token that is returned upon login","scheme":"bearer","type":"http","bearerFormat":"jwt"},"accessKey":{"description":"Uses the Authorization header: 'AccessKey ' followed by your access key token","scheme":"AccessKey","type":"http"}},"schemas":{"UpdateSenderProfile":{"type":"object","additionalProperties":false,"properties":{"name":{"nullable":true,"type":"string"},"username":{"nullable":true,"type":"string"},"signature":{"nullable":true,"type":"string"},"allowedEntities":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/SenderProfileAllowedEntity"}},"channelId":{"type":"string","maxLength":60}}},"SenderProfileAllowedEntity":{"type":"object","additionalProperties":false,"required":["entityType","entityId"],"properties":{"entityType":{"type":"string","enum":["team","agent"]},"operation":{"type":"string","enum":["view","edit"]},"entityId":{"type":"string","maxLength":60}}},"SenderProfile":{"type":"object","additionalProperties":false,"required":["id","name","channelId","createdAt","updatedAt"],"properties":{"id":{"type":"string","maxLength":60},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/SenderProfileEmail"},"allowedEntities":{"type":"array","items":{"$ref":"#/components/schemas/SenderProfileAllowedEntity"}},"channelId":{"type":"string","maxLength":60},"signature":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"SenderProfileEmail":{"type":"object","additionalProperties":false,"required":["username","domain"],"properties":{"username":{"type":"string"},"domain":{"type":"string"}}},"error.detailed":{"additionalProperties":false,"description":"An error returned from the API that includes additional details about the error. The `details` property can contain any additional information about the error that may be helpful for debugging or understanding the error.\n","properties":{"code":{"description":"A unique code that identifies the error. This code can be used to programmatically identify the error.","minLength":3,"type":"string"},"details":{"additionalProperties":true,"description":"Any additional information about the error that may be helpful for debugging or understanding the error.","type":"object"},"message":{"description":"A human-readable message that describes the error.","minLength":1,"type":"string"}},"required":["code","message"],"title":"DetailedError","type":"object"},"error.validation":{"additionalProperties":false,"description":"A validation error returned from the API. The `details` map keys are JSON paths\npointing into the request body / parameters; values are arrays of human-readable\nmessages describing each problem with that path.\n","properties":{"code":{"description":"A unique code that identifies the error. This code can be used to programmatically identify the error.","minLength":3,"type":"string"},"details":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Per-field validation messages keyed by JSON path.","type":"object"},"message":{"description":"A human-readable message that describes the error.","minLength":1,"type":"string"}},"required":["code","message"],"title":"ValidationError","type":"object"}},"responses":{"error.response.not_found":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.detailed"}}},"description":"The requested resource was not found."},"error.response.invalid_request":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.validation"}}},"description":"The request contains invalid parameters or body fields."}}},"paths":{"/workspaces/{workspaceId}/sender-profiles/{senderProfileId}":{"patch":{"description":"Modify the details of a specific sender profile, such as its name or other attributes.","operationId":"updateSenderProfile","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSenderProfile"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SenderProfile"}}},"description":"updated"},"404":{"$ref":"#/components/responses/error.response.not_found"},"422":{"$ref":"#/components/responses/error.response.invalid_request"}},"summary":"Update Sender profile","tags":["sender_profile"]}}}} ``` ## Delete Sender Profile > Remove a specific sender profile. ```json {"openapi":"3.0.3","info":{"title":"Collaboration","version":"v1"},"tags":[{"description":"Manage sender profiles","name":"sender_profile"}],"security":[{"user":[]},{"accessKey":[]}],"components":{"securitySchemes":{"user":{"description":"Provide the token that is returned upon login","scheme":"bearer","type":"http","bearerFormat":"jwt"},"accessKey":{"description":"Uses the Authorization header: 'AccessKey ' followed by your access key token","scheme":"AccessKey","type":"http"}},"responses":{"error.response.not_found":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.detailed"}}},"description":"The requested resource was not found."}},"schemas":{"error.detailed":{"additionalProperties":false,"description":"An error returned from the API that includes additional details about the error. The `details` property can contain any additional information about the error that may be helpful for debugging or understanding the error.\n","properties":{"code":{"description":"A unique code that identifies the error. This code can be used to programmatically identify the error.","minLength":3,"type":"string"},"details":{"additionalProperties":true,"description":"Any additional information about the error that may be helpful for debugging or understanding the error.","type":"object"},"message":{"description":"A human-readable message that describes the error.","minLength":1,"type":"string"}},"required":["code","message"],"title":"DetailedError","type":"object"}}},"paths":{"/workspaces/{workspaceId}/sender-profiles/{senderProfileId}":{"delete":{"description":"Remove a specific sender profile.","operationId":"deleteSenderProfile","responses":{"204":{"description":"Deleted"},"404":{"$ref":"#/components/responses/error.response.not_found"}},"summary":"Delete Sender Profile","tags":["sender_profile"]}}}} ``` ## List of variable for signature in sender profiles > Retrieve a list of variables to use for signature configuration in sender profile. ```json {"openapi":"3.0.3","info":{"title":"Collaboration","version":"v1"},"tags":[{"description":"Manage sender profiles","name":"sender_profile"}],"security":[{"user":[]},{"accessKey":[]}],"components":{"securitySchemes":{"user":{"description":"Provide the token that is returned upon login","scheme":"bearer","type":"http","bearerFormat":"jwt"},"accessKey":{"description":"Uses the Authorization header: 'AccessKey ' followed by your access key token","scheme":"AccessKey","type":"http"}},"schemas":{"SignatureVariablesList":{"type":"object","required":["results"],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/SignatureVariable"}}}},"SignatureVariable":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"name":{"type":"string"},"defaultDescription":{"type":"string"},"variable":{"type":"string"},"category":{"type":"string"},"replacementAttribute":{"type":"string","nullable":true},"langDescription":{"type":"object","nullable":true}}},"error.detailed":{"additionalProperties":false,"description":"An error returned from the API that includes additional details about the error. The `details` property can contain any additional information about the error that may be helpful for debugging or understanding the error.\n","properties":{"code":{"description":"A unique code that identifies the error. This code can be used to programmatically identify the error.","minLength":3,"type":"string"},"details":{"additionalProperties":true,"description":"Any additional information about the error that may be helpful for debugging or understanding the error.","type":"object"},"message":{"description":"A human-readable message that describes the error.","minLength":1,"type":"string"}},"required":["code","message"],"title":"DetailedError","type":"object"},"error.validation":{"additionalProperties":false,"description":"A validation error returned from the API. The `details` map keys are JSON paths\npointing into the request body / parameters; values are arrays of human-readable\nmessages describing each problem with that path.\n","properties":{"code":{"description":"A unique code that identifies the error. This code can be used to programmatically identify the error.","minLength":3,"type":"string"},"details":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Per-field validation messages keyed by JSON path.","type":"object"},"message":{"description":"A human-readable message that describes the error.","minLength":1,"type":"string"}},"required":["code","message"],"title":"ValidationError","type":"object"}},"responses":{"error.response.not_found":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.detailed"}}},"description":"The requested resource was not found."},"error.response.invalid_request":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.validation"}}},"description":"The request contains invalid parameters or body fields."}}},"paths":{"/workspaces/{workspaceId}/sender-profiles/signature-variables":{"get":{"description":"Retrieve a list of variables to use for signature configuration in sender profile.","operationId":"listSenderSignatureVariables","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureVariablesList"}}},"description":"ok"},"404":{"$ref":"#/components/responses/error.response.not_found"},"422":{"$ref":"#/components/responses/error.response.invalid_request"}},"summary":"List of variable for signature in sender profiles","tags":["sender_profile"]}}}} ``` ## List sender profiles > Retrieve a list of sender profiles associated with a user. ```json {"openapi":"3.0.3","info":{"title":"Collaboration","version":"v1"},"tags":[{"description":"Manage sender profiles","name":"sender_profile"}],"security":[{"user":[]},{"accessKey":[]}],"components":{"securitySchemes":{"user":{"description":"Provide the token that is returned upon login","scheme":"bearer","type":"http","bearerFormat":"jwt"},"accessKey":{"description":"Uses the Authorization header: 'AccessKey ' followed by your access key token","scheme":"AccessKey","type":"http"}},"parameters":{"queryChannelId":{"description":"Filter by channelId","in":"query","name":"channelId","schema":{"maxLength":60,"type":"string"}}},"schemas":{"SenderProfileList":{"type":"object","required":["results"],"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/SenderProfile"}}}},"SenderProfile":{"type":"object","additionalProperties":false,"required":["id","name","channelId","createdAt","updatedAt"],"properties":{"id":{"type":"string","maxLength":60},"name":{"type":"string"},"email":{"$ref":"#/components/schemas/SenderProfileEmail"},"allowedEntities":{"type":"array","items":{"$ref":"#/components/schemas/SenderProfileAllowedEntity"}},"channelId":{"type":"string","maxLength":60},"signature":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"SenderProfileEmail":{"type":"object","additionalProperties":false,"required":["username","domain"],"properties":{"username":{"type":"string"},"domain":{"type":"string"}}},"SenderProfileAllowedEntity":{"type":"object","additionalProperties":false,"required":["entityType","entityId"],"properties":{"entityType":{"type":"string","enum":["team","agent"]},"operation":{"type":"string","enum":["view","edit"]},"entityId":{"type":"string","maxLength":60}}},"error.detailed":{"additionalProperties":false,"description":"An error returned from the API that includes additional details about the error. The `details` property can contain any additional information about the error that may be helpful for debugging or understanding the error.\n","properties":{"code":{"description":"A unique code that identifies the error. This code can be used to programmatically identify the error.","minLength":3,"type":"string"},"details":{"additionalProperties":true,"description":"Any additional information about the error that may be helpful for debugging or understanding the error.","type":"object"},"message":{"description":"A human-readable message that describes the error.","minLength":1,"type":"string"}},"required":["code","message"],"title":"DetailedError","type":"object"},"error.validation":{"additionalProperties":false,"description":"A validation error returned from the API. The `details` map keys are JSON paths\npointing into the request body / parameters; values are arrays of human-readable\nmessages describing each problem with that path.\n","properties":{"code":{"description":"A unique code that identifies the error. This code can be used to programmatically identify the error.","minLength":3,"type":"string"},"details":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Per-field validation messages keyed by JSON path.","type":"object"},"message":{"description":"A human-readable message that describes the error.","minLength":1,"type":"string"}},"required":["code","message"],"title":"ValidationError","type":"object"}},"responses":{"error.response.not_found":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.detailed"}}},"description":"The requested resource was not found."},"error.response.invalid_request":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.validation"}}},"description":"The request contains invalid parameters or body fields."}}},"paths":{"/workspaces/{workspaceId}/users/{userId}/sender-profiles":{"get":{"description":"Retrieve a list of sender profiles associated with a user.","operationId":"listUserSenderProfiles","parameters":[{"$ref":"#/components/parameters/queryChannelId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SenderProfileList"}}},"description":"ok"},"404":{"$ref":"#/components/responses/error.response.not_found"},"422":{"$ref":"#/components/responses/error.response.invalid_request"}},"summary":"List sender profiles","tags":["sender_profile"]}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.bird.com/api/collaborations-api/api-reference/sender-profiles.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.